Skip to content
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: render visibility on associated types #110945

Merged
merged 3 commits into from Jun 5, 2023

Conversation

wackbyte
Copy link
Contributor

@wackbyte wackbyte commented Apr 28, 2023

This should only affect inherent associated types (#8995).

@rustbot
Copy link
Collaborator

rustbot commented Apr 28, 2023

r? @jsha

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Apr 28, 2023
@rust-log-analyzer

This comment has been minimized.

This should only affect inherent associated types.
@wackbyte wackbyte force-pushed the doc-vis-on-inherent-assoc-types branch from 46a6844 to db5d3f0 Compare April 28, 2023 12:25
@rustbot rustbot added F-inherent_associated_types `#![feature(inherent_associated_types)]` A-rustdoc-ui Area: rustdoc UI (generated HTML) labels Apr 28, 2023
Copy link
Member

@fmease fmease left a comment

Choose a reason for hiding this comment

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

Thanks for catching and fixing this! I've marked one thing that definitely needs to be addressed.
Apart from that, I think it would be good to add at least one more test (file) that explicitly checks for the new behavior (e.g. with @has) instead of relying on this @snapshot test that could accidentally get --blessed in the future without notice.

tests/rustdoc/anchors.no_type_anchor2.html Outdated Show resolved Hide resolved
@wackbyte
Copy link
Contributor Author

I added the test to the existing visibility test with tests for other associated items as well.

@wackbyte wackbyte requested a review from fmease May 7, 2023 20:51
Copy link
Member

@fmease fmease left a comment

Choose a reason for hiding this comment

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

Thanks for adding the test 👍

LGTM (I personally don't have bors rights, so I cannot bors-approve)

@jsha
Copy link
Contributor

jsha commented Jun 4, 2023

Thanks for the fix, @wackbyte! Sorry I took so long to review this. Looks good to me as well - and thanks @fmease for the review.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jun 4, 2023

📌 Commit 16749d1 has been approved by jsha

It is now in the queue for this repository.

@bors bors 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 Jun 4, 2023
@bors
Copy link
Contributor

bors commented Jun 5, 2023

⌛ Testing commit 16749d1 with merge 51f714c...

@bors
Copy link
Contributor

bors commented Jun 5, 2023

☀️ Test successful - checks-actions
Approved by: jsha
Pushing 51f714c to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Jun 5, 2023
@bors bors merged commit 51f714c into rust-lang:master Jun 5, 2023
12 checks passed
@rustbot rustbot added this to the 1.72.0 milestone Jun 5, 2023
@wackbyte wackbyte deleted the doc-vis-on-inherent-assoc-types branch June 5, 2023 09:36
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (51f714c): comparison URL.

Overall result: ❌ regressions - no action needed

@rustbot label: -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)
- - 0
Regressions ❌
(secondary)
1.1% [1.1%, 1.1%] 1
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
- - 0
All ❌✅ (primary) - - 0

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)
- - 0
Regressions ❌
(secondary)
- - 0
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
-2.3% [-2.7%, -1.8%] 4
All ❌✅ (primary) - - 0

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)
- - 0
Regressions ❌
(secondary)
2.7% [2.0%, 4.3%] 5
Improvements ✅
(primary)
-3.0% [-3.0%, -3.0%] 1
Improvements ✅
(secondary)
- - 0
All ❌✅ (primary) -3.0% [-3.0%, -3.0%] 1

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 646.537s -> 645.963s (-0.09%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: rustdoc UI (generated HTML) F-inherent_associated_types `#![feature(inherent_associated_types)]` merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants