adafruit / adafruit/Adafruit_CircuitPython_RFM9x

Library uses short argument names

Open
#84 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
76
Forks
53
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 auditing the library's short argument names against pylint's three-letter recommendation, then trace the affected Learn Guides and other code-snippet references. Done means the renaming scope is agreed, references are updated consistently, and the disabled warnings can be reconsidered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
embedded-iot
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.