rustdoc: Allow linking from private items to private types by dennis-hamester · Pull Request #74147 · rust-lang/rust

dennis-hamester · 2020-07-08T07:49:39Z

After PR #72771 this would trigger an intra_doc_link_resolution_failure warning
when rustdoc is invoked without --document-private-items. Links from private
items to private types are however never actually generated in that case and
thus shouldn't produce a warning. These links are in fact a very useful tool to
document crate internals.

Tests are added for all 4 combinations of public/private items and link
targets. Test 1 is the case mentioned above and fails without this commit. Tests
2 - 4 passed before already but are added nonetheless to prevent regressions.

Fixesrust-lang#74134 After PR rust-lang#72771 this would trigger an intra_doc_link_resolution_failure warning when rustdoc is invoked without --document-private-items. Links from private items to private types are however never actually generated in that case and thus shouldn't produce a warning. These links are in fact a very useful tool to document crate internals. Tests are added for all 4 combinations of public/private items and link targets. Test 1 is the case mentioned above and fails without this commit. Tests 2 - 4 passed before already but are added nonetheless to prevent regressions.

rust-highfive · 2020-07-08T07:49:42Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ollie27 (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

This works around issue #74134 in rustdoc and should be reverted when PR #74147 is merged and available in a nightly. - #74134: rust-lang/rust#74134 - #74147: rust-lang/rust#74147

jyn514 · 2020-07-10T03:00:38Z

r? @jyn514

jyn514

r=me modulo nits

As per the discussion in PR rust-lang#74147, the 4 individual tests are replaced by a single one. The test is expanded to cover all 4 public/private cases, each with and without --document-private-items.

Manishearth · 2020-07-11T15:13:45Z

@bors delegate=jyn514

test seems okay

bors · 2020-07-11T15:13:46Z

✌️ @jyn514 can now approve this pull request

jyn514 · 2020-07-11T15:58:22Z

@bors r=@jyn514

bors · 2020-07-11T15:58:23Z

📌 Commit 8789525 has been approved by jyn514

Manishearth · 2020-07-11T16:00:59Z

(you can just r+, r=foo is if you need to r+ on behalf of someone)

jyn514 · 2020-07-11T16:25:07Z

@bors rollup=always

Manishearth · 2020-07-11T16:48:19Z

rollup=always is not really what i'd do here, but it's fine

jyn514 · 2020-07-13T14:29:17Z

@bors rollup=maybe

Since this has been waiting for a while, let's give it a chance to make it to the top of the queue.

Manishearth · 2020-07-13T15:10:09Z

(it doesn't matter, it's been waiting for a while because the queue isn't doing great. PRs that are not rollup-never or rollup-iffy are unlikely to be built on their own)

…jyn514 rustdoc: Allow linking from private items to private types Fixesrust-lang#74134 After PR rust-lang#72771 this would trigger an intra_doc_link_resolution_failure warning when rustdoc is invoked without --document-private-items. Links from private items to private types are however never actually generated in that case and thus shouldn't produce a warning. These links are in fact a very useful tool to document crate internals. Tests are added for all 4 combinations of public/private items and link targets. Test 1 is the case mentioned above and fails without this commit. Tests 2 - 4 passed before already but are added nonetheless to prevent regressions.

@ghost

…arth Rollup of 8 pull requests Successful merges: - rust-lang#73354 (Update RELEASES.md for 1.45.0) - rust-lang#73852 (rustdoc: insert newlines between attributes) - rust-lang#73867 (Document the union keyword) - rust-lang#74046 (Fix caching issue when building tools.) - rust-lang#74123 (clean up E0718 explanation) - rust-lang#74147 (rustdoc: Allow linking from private items to private types) - rust-lang#74285 (rust-lang#71669: add ui, codegen tests for volatile + nearby int intrinsics) - rust-lang#74286 (Added detailed error code explanation for issue E0688 in Rust compiler.) Failed merges: r? @ghost

…-priv, r=jyn514 rustdoc: Always warn when linking from public to private items Change the logic such that linking from a public to a private item always triggers `intra_doc_link_resolution_failure`. Previously, the warning was not emitted when `--document-private-items` is passed. This came up during the discussion in rust-lang#74147 (comment).

rust-highfive assigned ollie27 Jul 8, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 8, 2020

jyn514 approved these changes Jul 10, 2020
View reviewed changes

Comment threadsrc/test/rustdoc/issue-74134-2.rs Outdated
Comment threadsrc/test/rustdoc/issue-74134-4.rs Outdated
Comment threadsrc/test/rustdoc/issue-74134-4.rs Outdated

Manishearth reviewed Jul 10, 2020
View reviewed changes

Comment threadsrc/librustdoc/passes/collect_intra_doc_links.rs

dennis-hamester added 3 commits July 11, 2020 09:26

test: rustdoc-ui: Add issue-74134, replacing test/rustdoc/issue-74134-*
689e360
As per the discussion in PR rust-lang#74147, the 4 individual tests are replaced by a single one. The test is expanded to cover all 4 public/private cases, each with and without --document-private-items.

test: rustdoc-ui: Expand issue-74134 to cover types in a private module
9704859

test: rustdoc-ui: issue-74134: Shorten a too long line
8789525

nrc mentioned this pull request Jul 11, 2020
Tracking issue for RFC 1946 - intra-rustdoc links #43466
Closed
27 tasks

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 Jul 11, 2020

Manishearth mentioned this pull request Jul 13, 2020
Rollup of 18 pull requests #74303
Closed

Manishearth mentioned this pull request Jul 13, 2020
Rollup of 18 pull requests #74305
Closed

Manishearth mentioned this pull request Jul 13, 2020
Rollup of 17 pull requests #74306
Closed

Manishearth mentioned this pull request Jul 13, 2020
Rollup of 18 pull requests #74308
Closed

Manishearth mentioned this pull request Jul 14, 2020
Rollup of 18 pull requests #74309
Closed

Manishearth mentioned this pull request Jul 14, 2020
Rollup of 11 pull requests #74312
Closed

Manishearth mentioned this pull request Jul 14, 2020
Rollup of 8 pull requests #74313
Merged

bors merged commit e4a9b36 into rust-lang:masterJul 14, 2020

dennis-hamester deleted the fix/issue-74134 branch July 14, 2020 16:37

dennis-hamester mentioned this pull request Jul 17, 2020
rustdoc: Always warn when linking from public to private items #74460
Merged

cuviper added this to the 1.46 milestone May 2, 2024

Uh oh!

Uh oh!

Conversation

dennis-hamester commented Jul 8, 2020

Uh oh!

rust-highfive commented Jul 8, 2020

Uh oh!

jyn514 commented Jul 10, 2020

Uh oh!

jyn514 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Manishearth commented Jul 11, 2020

Uh oh!

bors commented Jul 11, 2020

Uh oh!

jyn514 commented Jul 11, 2020

Uh oh!

bors commented Jul 11, 2020

Uh oh!

Manishearth commented Jul 11, 2020

Uh oh!

jyn514 commented Jul 11, 2020

Uh oh!

Manishearth commented Jul 11, 2020

Uh oh!

jyn514 commented Jul 13, 2020

Uh oh!

Manishearth commented Jul 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants