ARMmbed / ARMmbed/mbed-drivers
pinmap_pinout : missing documentation of behavior (sets pin to PullNone)
- Dominant language
- C++
- Stars
- 39
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
It is easy to miss the fact that the pinmap_pinout() function also sets the pin to PullNone. This is fine as long as the hal implementation sets the pin to PullUp or PullDown if needed after calling pinmap_pinout and not before. Should be documented in comments and api documentation if possible.
Contributor guide
No contributing guide indexed for this repository
Research direction
Search the repository for the pinmap_pinout() definition, its comments, and the API documentation entry. Document that it sets the pin to PullNone and clarify that the HAL should apply PullUp or PullDown afterward when needed; verify the documentation build if one is available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100