adafruit / adafruit/Adafruit_CircuitPython_BLE
More thorough documentation
- Dominant language
- Python
- Stars
- 138
- Forks
- 58
- PR merge metrics
- No merged PRs in 30d
Description
The library could really use more thorough documentation, through more examples, overview text, a, detailed explanatory text. A Learn Guide is probably appropriate, but there should be more inline documentation too. The declarative nature of `Service` and `Advertisement` needs to be more thoroughly explained, for example.
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the existing library documentation and the Service and Advertisement APIs, focusing on their declarative nature. Define the Learn Guide, overview text, examples, and inline explanations needed; done means newcomers can understand and use these concepts from the documentation without relying on undocumented behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100