adafruit / adafruit/Adafruit_LED_Backpack

writeDataRaw() & writeDigitAscii() descriptions are incorrect & incomplete

Open
#70 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
317
Forks
194
PR merge metrics
No merged PRs in 30d

Description

http://adafruit.github.io/Adafruit_LED_Backpack/html/class_adafruit__7segment.html
says writeDigitRaw() parameter x is "Character position (0-3)." It is 0-4 with character position 2 being the ":" in the display. It would also be helpful to explain that both LEDs in the display ":" (I expected them to be individually controlled) are controlled by bit1 of the bitmask parameter (I expected bit0) and all other bitmask bits are ignored.

Similarly it says writeDigitAscii() parameter x is "Character position" and nothing more. It is also 0 to 4 with character 2 being the ":" in the display. It is unclear what to expect when writing an ASCII character with "dot" true or false to the display ":" (I didn't try it.) It seems like this is an coding error that now should just be clearly documented and supported. The function interface would have been better written as character positions 0 to 3 and nothing to do with the ":" in the display.

I'm not sure if those are the only errors on that page, but encourage someone that understands the code better to proofread the Doxygen documentation -- It is the first place I go when trying to understand libraries. And many thanks for the libraries -- They are very useful and valuable.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked Adafruit_LED_Backpack Doxygen page and locate the declarations and documentation for writeDigitRaw() and writeDigitAscii(). Compare the parameter descriptions with the stated 0–4 positions, colon behavior, and dot handling, then update the Doxygen text and proofread nearby documentation for similar errors. Done means the generated documentation accurately describes supported behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.