Improve documentation about maintaining LineHandles #30
Conversation
This file contains 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
This commit addresses \rust-embedded#29 by expanding the documentation to explain the importance of maintaining valid LineHandles in a program that uses this library. - A comment was added to the Read State code example in the README to explain that the LineHandle must be maintained for the line to work - A similar comment was added to the `driveoutput.rs` example - A brief explanation was added to the section entitled "Exporting" a GPIO of the README about the file descriptor that is associated with a line
nastevens
approved these changes
Jan 15, 2020
posborne
approved these changes
Jan 15, 2020
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Jan 15, 2020
30: Improve documentation about maintaining LineHandles r=nastevens a=kmdouglass This commit addresses #29 by expanding the documentation to explain the importance of maintaining valid LineHandles in a program that uses this library. - A comment was added to the Read State code example in the README to explain that the LineHandle must be maintained for the line to work - A similar comment was added to the `driveoutput.rs` example - A brief explanation was added to the section entitled "Exporting" a GPIO of the README about the file descriptor that is associated with a line Co-authored-by: Kyle M. Douglass <kyle.m.douglass@gmail.com>
Build succeeded |
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.
This commit addresses #29 by expanding the documentation to explain the
importance of maintaining valid LineHandles in a program that uses this library.
that the LineHandle must be maintained for the line to work
driveoutput.rsexamplethe README about the file descriptor that is associated with a line