-
Notifications
You must be signed in to change notification settings - Fork 12.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rustdoc: Do not list impl when trait has doc(hidden) #86513
Merged
bors
merged 3 commits into
rust-lang:master
from
fee1-dead-contrib:cross-crate-doc-hidden
Jun 25, 2021
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
#[doc(hidden)] | ||
pub enum HiddenType {} | ||
|
||
#[doc(hidden)] | ||
pub trait HiddenTrait {} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
// Issue #86448: test for cross-crate `doc(hidden)` | ||
#![crate_name = "foo"] | ||
|
||
// aux-build:cross-crate-hidden.rs | ||
extern crate cross_crate_hidden; | ||
|
||
pub use ::cross_crate_hidden::{HiddenType, HiddenTrait}; // OK, not re-exported | ||
|
||
pub enum MyLibType {} | ||
|
||
// @!has foo/enum.MyLibType.html '//*[@id="impl-From%3CHiddenType%3E"]' 'impl From<HiddenType> for MyLibType' | ||
impl From<HiddenType> for MyLibType { | ||
fn from(it: HiddenType) -> MyLibType { | ||
match it {} | ||
} | ||
} | ||
|
||
pub struct T<T>(T); | ||
|
||
// @!has foo/enum.MyLibType.html '//*[@id="impl-From%3CT%3CT%3CT%3CT%3CHiddenType%3E%3E%3E%3E%3E"]' 'impl From<T<T<T<T<HiddenType>>>>> for MyLibType' | ||
impl From<T<T<T<T<HiddenType>>>>> for MyLibType { | ||
fn from(it: T<T<T<T<HiddenType>>>>) -> MyLibType { | ||
todo!() | ||
} | ||
} | ||
|
||
// @!has foo/enum.MyLibType.html '//*[@id="impl-HiddenTrait"]' 'impl HiddenTrait for MyLibType' | ||
impl HiddenTrait for MyLibType {} | ||
|
||
// @!has foo/struct.T.html '//*[@id="impl-From%3CMyLibType%3E"]' 'impl From<MyLibType> for T<T<T<T<HiddenType>>>>' | ||
impl From<MyLibType> for T<T<T<T<HiddenType>>>> { | ||
fn from(it: MyLibType) -> T<T<T<T<HiddenType>>>> { | ||
match it {} | ||
} | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you also test this for the same-crate case?
(not sure if revisions work for rustdoc tests - if not, it's fine to make these two separate tests.)
Please also change the file name from
cross-crate-hidden
tocross-crate-hidden-impl-parameter
, which I think is a more accurate description.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
revisions do not work - I have added a separate test
@rustbot label -S-waiting-on-author S-waiting-on-review