Improve documentation on generated registers and fields #468
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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
S-waiting-on-review
burrbull
approved these changes
Aug 17, 2020
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Aug 30, 2020
468: Improve documentation on generated registers and fields r=burrbull a=couchand Previously, the descriptions for fields were only listed on the docs for the accessor methods on the `R` and `W` structs. This adds the descriptions to the field accessor structs so they appear on the register module page, too. Co-authored-by: Andrew Dona-Couch <hi@andrewcou.ch>
|
Build failed:
|
|
bors retry |
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.
Previously, the descriptions for fields were only listed on the docs for the accessor methods on the
RandWstructs. This adds the descriptions to the field accessor structs so they appear on the register module page, too.