adafruit / adafruit/Adafruit_CircuitPython_MAX31865

Library uses short argument names

Open
#38 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
22
Forks
10
PR merge metrics
No merged PRs in 30d

Description

`pylint` suggests using argument names with at least 3 letters. This library uses argument names of shorter length, and while these warnings have been disabled for now, they should be considered for renaming. This may require the rework of Learn Guides and other references to code snippets.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the library's short argument names and the Learn Guides and other code snippets that reference them. Review the disabled pylint warnings, then define completion as consistent argument renaming across the library and all identified references without those warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, embedded-iot
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.