Improve types struct and enum rustdocs
#353
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
The rustodcs for the RPCs in types in inconsistent. In particular the sub structs and enums don't always mention which RPC they are part of. This makes it harder to understand which bit go with which. Make all the rustdocs consistent and mention which RPC they are part of.
jamillambert
force-pushed
the
0909-types-rustdocs
branch
from
2c29821 to
9a4e53c
Compare
tcharding
approved these changes
Sep 9, 2025
Member
|
Mad. Did you do this manually or were you able to get an LLM to do it? |
blaze-smith470pm
added a commit
to blaze-smith470pm/corepc
that referenced
this pull request
Sep 26, 2025
9a4e53c781e0ab2cb4246d3f214a3787325fc33d Improve types struct and enum rustdocs (Jamil Lambert, PhD)
Pull request description:
The rustdocs for the RPCs in types in inconsistent. In particular the sub structs and enums don't always mention which RPC they are part of. This makes it harder to understand which bit goes with which.
Use the same language throughout so that when scanning through the code it is easier to follow.
Make all the rustdocs consistent and mention which RPC they are part of.
ACKs for top commit:
tcharding:
ACK 9a4e53c781e0ab2cb4246d3f214a3787325fc33d
Tree-SHA512: 0f497179df047ff488e0edbfb9c2eb936c79e006d98285833d06ee988811fc8585e854880e6271e274d0d099e409986ebf272a618af96f7d41e2670876968afe
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The rustdocs for the RPCs in types in inconsistent. In particular the sub structs and enums don't always mention which RPC they are part of. This makes it harder to understand which bit goes with which.
Use the same language throughout so that when scanning through the code it is easier to follow.
Make all the rustdocs consistent and mention which RPC they are part of.