Add #[doc(hidden)] to more generated functions and structs.
#1317
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
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 PR hides items with names such as
static_rocket_route_info_for_indexfrom documentation. I believe this covers all generated top-level items that were not already#[doc(hidden)].It might be nicer to provide some sort of documentation (#297), but I think hiding it is preferable until something like that exists.
Hidden items can still be documented with the following command:
RUSTDOCFLAGS='-Z unstable-options --document-hidden-items' cargo doc [--open]. It is expected that that command will be less cumbersome in the future (rust-lang/cargo#7766).