Hide generated dummy const in rustdoc#1768
Merged
dtolnay merged 1 commit intoserde-rs:masterfrom Apr 3, 2020
robo9k:dummy-const-hidden-doc
Merged
Hide generated dummy const in rustdoc#1768dtolnay merged 1 commit intoserde-rs:masterfrom robo9k:dummy-const-hidden-doc
dtolnay merged 1 commit intoserde-rs:masterfrom
robo9k:dummy-const-hidden-doc
Conversation
Member
|
Published in 1.0.106. |
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
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.
When creating a binary crate with a
src/main.rsand#[derive(Deserialize, Serialize)], runningcargo docon it will result in new doc items for generated constants:This is because Cargo runs with
--document-private-itemsinternally forsrc/main.rs. If you put the same code in asrc/lib.rsthe private items will not be documented by default, so you won't see them there for defaultcargo doc.The items will be visible both for
src/lib.rsandsrc/main.rsif thestructitself ispub.I believe the generated
_IMPL_{}_FOR_{}constants should not be visible in rustdoc and this merge request seems to fix the issue for me.