adafruit / adafruit/Adafruit_CircuitPython_IRRemote
Demo code in documentation of NonblockingGenericDecode does not work
- Dominant language
- Python
- Stars
- 29
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
The demo code in the inline documentation of [class NonblockingGenericDecode](https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/blob/c4daaa7521a491f7045cf10007764e95e4e2c265/adafruit_irremote.py#L204C1-L204C32) does not work. (I am not sure if this thought to be some sort of pseudo code?).
The code in the [corresponding example](https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/blob/c4daaa7521a491f7045cf10007764e95e4e2c265/examples/irremote_nonblocking.py#L14), in contrast, does work.
Contributor guide
No contributing guide indexed for this repository
Research direction
Compare the inline documentation for NonblockingGenericDecode in adafruit_irremote.py with the working example in examples/irremote_nonblocking.py. Reproduce the example behavior, then make the documented demo work consistently with the corresponding example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100