Minor additions to PIO documentation #831
Merged
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
lurch
approved these changes
May 17, 2022
| @@ -95,6 +95,9 @@ typedef pio_hw_t *PIO; | |||
|
|
|||
| /** \brief PIO Configuration structure | |||
| * \ingroup sm_config | |||
| * | |||
| * This structure is an in-memory representation of the configuration that can be applied to a PIO | |||
| * state machine later using pio_sm_set_config() or pio_sm_init(). | |||
There was a problem hiding this comment.
Not sure we need the word "later" in there, but otherwise LGTM.
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.
some functions were in the wrong documentation group, and I added a brief sentence for
pio_sm_config