Clarify paragraph value and add header comments to Touch_IRQ.ino and Touch_Polling.ino
#7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
leonardocavagnis
merged commit 4101b8a
into
arduino-libraries:main
1 of 3 checks passed
|
Thanks Ali! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In order to help Users better find and use the features provided by this library, this PR makes two improvements:
paragraphfield by reducing word count from 48 words to 37. Knowing that the library is a C++ library, while true, is not a priority for users looking for this library in the IDE. Including two terms of interrupt/IRQ and on-request/polling should make it easier to find.Touch_IRQ.inoandTouch_Polling.inoexample sketches by adding a header comment. This library provides an easy way to access the number of points and co-ordinates of the Goodix GT911 5-point capacitive touch controller without needing to configure the I2C registers by the Users. It is of value of Users to make this clear.