Add placeholder doc comments to macro-generated enums #2872
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
ealmloff
approved these changes
Aug 26, 2024
ealmloff
added
documentation
|
Thank you so much for finishing and landing this PR! |
pyrrho
added a commit
to pyrrho/dioxus
that referenced
this pull request
Aug 28, 2024
* Add placeholder doc comments to macro-generate enums * Add doc comments to generated router parse error enums --------- Co-authored-by: Evan Almloff <[email protected]>
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 removes some yellow squiggles present in workspaces/crates that build with
I don't feel that I'm familiar enough with the structure of these enums to suggest real doc comments, so I just tossed in placeholders. Would love to see some more descriptive text replace the TODOs.
Another option for resolving the warnings would be to replace all the placeholders with an
#[allow(missing_docs)]attribute added above the twoquote!dpub enums on lib.rs:689 and segment.rs:300