allow dead_code and missing_docs in generated output #56
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
This adds #[allow(dead_code)] to all structures and methods to suppress dead-code warnings when using the generated code.
This adds #[allow(missing_docs)] to the structs and methods as neccessary, prefering to use the description from the SVD instead.
|
Thanks for the PR, @crawford. If the generated code produces dead_code warnings, that indicates a bug in svd2rust or that svd2rust is being misused (e.g. you are not exposing the API as public). And I'd rather fix the missing_docs warnings by actually documenting better the API rather than just sprinkling allow(missing_docs) here and there. The docs generation will be revised in #53 so let's revisit this later. |
|
Okay, I'll have to double check my setup to figure out why I get all of those warnings. Looking forward to #53. |
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.
Fixes #18