rustdoc: Split out rustdoc pass to strip private imports #32055
Merged
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
mitaa
force-pushed
the
rdoc-strip-priv-imports
branch
from
774c8f1
to
5671166
Compare
|
cc @SimonSapin |
mitaa
force-pushed
the
rdoc-strip-priv-imports
branch
2 times, most recently
from
9d8f63e
to
745c7cf
Compare
| impl fold::DocFolder for ImportStripper { | ||
| fn fold_item(&mut self, i: Item) -> Option<Item> { | ||
| match i.inner { | ||
| clean::ExternCrateItem(..) | |
There was a problem hiding this comment.
This should also test visibility, right? #31362 made pub extern crate meaningful.
There was a problem hiding this comment.
I think the pattern guard on the next line should take care of that (?) 😃
Or do you mean a rustdoc test? I've added one since there doesn't appear to be any rustdoc test for pub extern crate.
There was a problem hiding this comment.
Never mind, I read this code too quickly and didn’t realize these two lines are the same match arm :)
|
Nice! This should make pages like http://doc.servo.org/servo/index.html#reexports much less noisy. Thanks @mitaa! |
mitaa
force-pushed
the
rdoc-strip-priv-imports
branch
from
745c7cf
to
180b1a9
Compare
|
(highfive might be awake again) |
mitaa
force-pushed
the
rdoc-strip-priv-imports
branch
from
180b1a9
to
688e522
Compare
bors
added a commit
that referenced
this pull request
Mar 6, 2016
| @@ -106,7 +106,7 @@ pub fn strip_private(mut krate: clean::Crate) -> plugins::PluginResult { | |||
| retained: &mut retained, | |||
| access_levels: &access_levels, | |||
| }; | |||
| krate = stripper.fold_crate(krate); | |||
| krate = ImportStripper.fold_crate(stripper.fold_crate(krate)); | |||
There was a problem hiding this comment.
Now that this change hit Nightly I’m trying it out but I’m surprised to not see strip-priv-imports listed in the default passes in rustdoc --passes list. As far as I understand it’s indeed not a default pass, but this line makes it implied by strip-private. This is not exactly wrong, but at least confusing.
Maybe add “, implies strip-priv-imports” should be added to the description for strip-private in src/librustdoc/lib.rs?
There was a problem hiding this comment.
Yes, I think that'd be a good idea. I'll submit a PR later if you or someone else hasn't by then.
SimonSapin
added a commit
to servo/servo
that referenced
this pull request
Mar 7, 2016
rust-lang/rust#32055 This will make e.g. http://doc.servo.org/servo/index.html#reexports stop listing `extern crate` and `use` statements that don’t have `pub`.
bors-servo
pushed a commit
to servo/servo
that referenced
this pull request
Mar 7, 2016
Use rustdoc’s new `--passes strip-priv-imports` flag. rust-lang/rust#32055 This will make e.g. http://doc.servo.org/servo/index.html#reexports stop listing `extern crate` and `use` statements that don’t have `pub`. <!-- Reviewable:start --> [<img src="https://reviewable.io/review_button.svg" height="40" alt="Review on Reviewable"/>](https://reviewable.io/reviews/servo/servo/9894) <!-- Reviewable:end -->
bors-servo
pushed a commit
to servo/servo
that referenced
this pull request
Mar 8, 2016
Use rustdoc’s new `--passes strip-priv-imports` flag. rust-lang/rust#32055 This will make e.g. http://doc.servo.org/servo/index.html#reexports stop listing `extern crate` and `use` statements that don’t have `pub`. <!-- Reviewable:start --> [<img src="https://reviewable.io/review_button.svg" height="40" alt="Review on Reviewable"/>](https://reviewable.io/reviews/servo/servo/9894) <!-- Reviewable:end -->
bors-servo
pushed a commit
to servo/servo
that referenced
this pull request
Mar 8, 2016
Use rustdoc’s new `--passes strip-priv-imports` flag. rust-lang/rust#32055 This will make e.g. http://doc.servo.org/servo/index.html#reexports stop listing `extern crate` and `use` statements that don’t have `pub`. <!-- Reviewable:start --> [<img src="https://reviewable.io/review_button.svg" height="40" alt="Review on Reviewable"/>](https://reviewable.io/reviews/servo/servo/9894) <!-- Reviewable:end -->
gecko-dev-updater
pushed a commit
to marco-c/gecko-dev-comments-removed
that referenced
this pull request
Oct 1, 2019
…flag (from servo:strip-priv-imports); r=Ms2ger rust-lang/rust#32055 This will make e.g. http://doc.servo.org/servo/index.html#reexports stop listing `extern crate` and `use` statements that don’t have `pub`. Source-Repo: https://github.com/servo/servo Source-Revision: 1453f438256afe92b0f79980c984824aac4afeae UltraBlame original commit: 8429d073276a3daeb5d4403ad44274bc39113092
gecko-dev-updater
pushed a commit
to marco-c/gecko-dev-wordified-and-comments-removed
that referenced
this pull request
Oct 1, 2019
…flag (from servo:strip-priv-imports); r=Ms2ger rust-lang/rust#32055 This will make e.g. http://doc.servo.org/servo/index.html#reexports stop listing `extern crate` and `use` statements that don’t have `pub`. Source-Repo: https://github.com/servo/servo Source-Revision: 1453f438256afe92b0f79980c984824aac4afeae UltraBlame original commit: 8429d073276a3daeb5d4403ad44274bc39113092
gecko-dev-updater
pushed a commit
to marco-c/gecko-dev-wordified
that referenced
this pull request
Oct 1, 2019
…flag (from servo:strip-priv-imports); r=Ms2ger rust-lang/rust#32055 This will make e.g. http://doc.servo.org/servo/index.html#reexports stop listing `extern crate` and `use` statements that don’t have `pub`. Source-Repo: https://github.com/servo/servo Source-Revision: 1453f438256afe92b0f79980c984824aac4afeae UltraBlame original commit: 8429d073276a3daeb5d4403ad44274bc39113092
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 #27104
r? @alexcrichton