Skip to content

rustdoc: Don't show hidden trait methods - #89198

Merged
bors merged 2 commits into
rust-lang:masterfrom
hkmatsumoto:hide-hidden-methods
Sep 26, 2021
Merged

rustdoc: Don't show hidden trait methods#89198
bors merged 2 commits into
rust-lang:masterfrom
hkmatsumoto:hide-hidden-methods

Conversation

@hkmatsumoto

@hkmatsumotohkmatsumoto commented Sep 23, 2021

Copy link
Copy Markdown
Contributor

Fix#89186.

By skipping trait items whose attributes include hidden, we avoid showing such trait methods.

@rust-highfive

rust-highfive commented Sep 23, 2021

Copy link
Copy Markdown
Contributor

r? @ollie27

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 23, 2021
@hkmatsumoto

hkmatsumoto commented Sep 23, 2021

Copy link
Copy Markdown
ContributorAuthor

r? @jyn514

@rust-highfiverust-highfive assigned jyn514 and unassigned ollie27Sep 23, 2021
Kobzol
Kobzol reviewed Sep 23, 2021
View reviewed changes
Comment threadsrc/librustdoc/clean/inline.rs Outdated
@hkmatsumoto
hkmatsumoto marked this pull request as draft September 23, 2021 07:36
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Sep 23, 2021
jyn514
jyn514 suggested changes Sep 23, 2021
View reviewed changes

@jyn514jyn514 left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a test for this? It would go in src/test/rustdoc, there are instructions at https://rustc-dev-guide.rust-lang.org/rustdoc-internals.html#dotting-is-and-crossing-ts :)

The code looks great though!

@jyn514jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 23, 2021
@hkmatsumoto

hkmatsumoto commented Sep 23, 2021•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

2021-09-24-003435_7680x2160_scrot
Documenting with --document-hidden-items the indent is broken, and I'm a little clueless about what's causing this; do you have an idea on what could be wrong?

@hkmatsumoto
hkmatsumoto marked this pull request as ready for review September 23, 2021 15:39
@hkmatsumotohkmatsumoto added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 23, 2021
jyn514
jyn514 reviewed Sep 23, 2021
View reviewed changes
Comment threadsrc/librustdoc/clean/inline.rs Outdated
@jyn514jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 23, 2021
@hkmatsumotohkmatsumoto added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 25, 2021
@hkmatsumoto
rustdoc: Don't show hidden trait methods
3239f06
By skipping trait items whose attributes include `hidden`, we void
showing
such trait methods.
jyn514
jyn514 approved these changes Sep 25, 2021
View reviewed changes

@jyn514jyn514 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thank you! r=me with or without the nit (please use r=jyn514, not r+).

Comment threadsrc/librustdoc/clean/inline.rs Outdated
@jyn514

jyn514 commented Sep 25, 2021

Copy link
Copy Markdown
Member

@bors delegate=hkmatsumoto

@bors

bors commented Sep 25, 2021

Copy link
Copy Markdown
Collaborator

✌️ @hkmatsumoto can now approve this pull request

@hkmatsumoto@jyn514
Elaborate comment
195f752
Co-authored-by: Joshua Nelson <github@jyn.dev>
@hkmatsumoto

hkmatsumoto commented Sep 25, 2021

Copy link
Copy Markdown
ContributorAuthor

@bors r=jyn514

@bors

bors commented Sep 25, 2021

Copy link
Copy Markdown
Collaborator

📌 Commit 195f752 has been approved by jyn514

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 25, 2021
@ManishearthManishearth mentioned this pull request Sep 26, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 26, 2021
@bors
Auto merge ofrust-lang#89262- Manishearth:rollup-vtkbetm, r=Manishe…
4da89a1
…arth
Rollup of 7 pull requests
Successful merges:
- rust-lang#88895 (rustdoc: Cleanup `clean` part 2)
- rust-lang#88973 (Expose the std_detect env_override feature)
- rust-lang#89010 (Add some intra doc links)
- rust-lang#89198 (rustdoc: Don't show hidden trait methods)
- rust-lang#89216 (Consistent big O notation)
- rust-lang#89224 (Change the order of imports suggestions)
- rust-lang#89256 (Fix typo in release notes)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit c118d8b into rust-lang:masterSep 26, 2021
@rustbotrustbot added this to the 1.57.0 milestone Sep 26, 2021
@jyn514

jyn514 commented Sep 26, 2021

Copy link
Copy Markdown
Member

@hkmatsumoto thank you for fixing this, it's awesome work!

@hkmatsumoto
hkmatsumoto deleted the hide-hidden-methods branch September 26, 2021 16:38
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@KobzolKobzolKobzol left review comments
+1 more reviewer
@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@jyn514jyn514

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.57.0

Development

Successfully merging this pull request may close these issues.

Rustdoc does not hide implementations of doc(hidden) trait methods

8 participants

@hkmatsumoto@rust-highfive@rust-log-analyzer@jyn514@bors@Kobzol@ollie27@rustbot