Separate `private_intra_doc_links` and `broken_intra_doc_links` into separate lints by jyn514 · Pull Request #77249 · rust-lang/rust

jyn514 · 2020-09-27T01:38:53Z

This is not ideal because it means deny(broken_intra_doc_links) will
no longer deny(private_intra_doc_links). However, it can't be fixed
with a new lint group, because broken is already in the rustdoc lint
group; there would need to be a way to nest groups somehow.

This also removes the early return so that the link will be generated
even though it gives a warning.

r? @Manishearth
cc @ecstatic-morse (#77242 (comment))

…separate lints This is not ideal because it means `deny(broken_intra_doc_links)` will no longer `deny(private_intra_doc_links)`. However, it can't be fixed with a new lint group, because `broken` is already in the `rustdoc` lint group; there would need to be a way to nest groups somehow. This also removes the early `return` so that the link will be generated even though it gives a warning.

Manishearth · 2020-09-27T14:37:17Z

@bors r+

bors · 2020-09-27T14:37:18Z

📌 Commit 51aab59d93778d4afd5dbe01b8e901a2847b092c has been approved by Manishearth

jyn514 · 2020-09-27T14:43:56Z

Oh lol it tried to run the example as a doc-test.

 ---- /checkout/src/doc/rustdoc/src/lints.md - Lints::private_intra_doc_links (line 92) stdout ----
error: unknown start of token: `
--> /checkout/src/doc/rustdoc/src/lints.md:93:35
|
3 | warning: public documentation for `public` links to private item `private`
| ^
|
help: Unicode character '`' (Grave Accent) looks like ''' (Single Quote), but it is not
|
3 | warning: public documentation for 'public` links to private item `private`
| ^

Let me try ignoring it.

jyn514 · 2020-09-27T14:48:37Z

@bors r=Manishearth

bors · 2020-09-27T14:48:38Z

📌 Commit 80ffaed has been approved by Manishearth

…as-schievink Rollup of 7 pull requests Successful merges: - rust-lang#76839 (Add asm! support for MIPS) - rust-lang#77203 (Check for missing const-stability attributes in `rustc_passes`) - rust-lang#77249 (Separate `private_intra_doc_links` and `broken_intra_doc_links` into separate lints) - rust-lang#77252 (reduce overlong line) - rust-lang#77256 (Fix typo in ExpnData documentation) - rust-lang#77262 (Remove duplicate comment) - rust-lang#77263 (Clean up trivial if let) Failed merges: r? `@ghost`

tiziano88 · 2020-10-19T17:56:32Z

It seems it is not possible to #![allow(private_intra_doc_links)] now, is this intended? How to disable this warning?

jyn514 · 2020-10-19T18:15:38Z

warning: unknown lint: `private_intra_doc_links`
--> private.rs:1:10
|
1 | #![allow(private_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links`
|
= note: `#[warn(unknown_lints)]` on by default
warning: public documentation for `DocMe` links to private item `DontDocMe`
--> private.rs:2:11
|
2 | /// docs [DontDocMe]
| ^^^^^^^^^ this item is private
|
= note: `#[warn(private_intra_doc_links)]` on by default
= note: this link will resolve properly if you pass `--document-private-items`

Well that's odd.

Recognize `private_intra_doc_links` as a lint Previously, trying to allow this would give another error! ``` warning: unknown lint: `private_intra_doc_links` --> private.rs:1:10 | 1 | #![allow(private_intra_doc_links)] | ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links` | = note: `#[warn(unknown_lints)]` on by default warning: public documentation for `DocMe` links to private item `DontDocMe` --> private.rs:2:11 | 2 | /// docs [DontDocMe] | ^^^^^^^^^ this item is private | = note: `#[warn(private_intra_doc_links)]` on by default = note: this link will resolve properly if you pass `--document-private-items` ``` Fixes the issue found in rust-lang#77249 (comment). r? `@Manishearth` Does anyone know why this additional step is necessary? It seems weird this has to be declared in 3 different places.

Recognize `private_intra_doc_links` as a lint Previously, trying to allow this would give another error! ``` warning: unknown lint: `private_intra_doc_links` --> private.rs:1:10 | 1 | #![allow(private_intra_doc_links)] | ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links` | = note: `#[warn(unknown_lints)]` on by default warning: public documentation for `DocMe` links to private item `DontDocMe` --> private.rs:2:11 | 2 | /// docs [DontDocMe] | ^^^^^^^^^ this item is private | = note: `#[warn(private_intra_doc_links)]` on by default = note: this link will resolve properly if you pass `--document-private-items` ``` Fixes the issue found in rust-lang#77249 (comment). r? ``@Manishearth`` Does anyone know why this additional step is necessary? It seems weird this has to be declared in 3 different places.

Recognize `private_intra_doc_links` as a lint Previously, trying to allow this would give another error! ``` warning: unknown lint: `private_intra_doc_links` --> private.rs:1:10 | 1 | #![allow(private_intra_doc_links)] | ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links` | = note: `#[warn(unknown_lints)]` on by default warning: public documentation for `DocMe` links to private item `DontDocMe` --> private.rs:2:11 | 2 | /// docs [DontDocMe] | ^^^^^^^^^ this item is private | = note: `#[warn(private_intra_doc_links)]` on by default = note: this link will resolve properly if you pass `--document-private-items` ``` Fixes the issue found in rust-lang#77249 (comment). r? ```@Manishearth``` Does anyone know why this additional step is necessary? It seems weird this has to be declared in 3 different places.

Recognize `private_intra_doc_links` as a lint Previously, trying to allow this would give another error! ``` warning: unknown lint: `private_intra_doc_links` --> private.rs:1:10 | 1 | #![allow(private_intra_doc_links)] | ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links` | = note: `#[warn(unknown_lints)]` on by default warning: public documentation for `DocMe` links to private item `DontDocMe` --> private.rs:2:11 | 2 | /// docs [DontDocMe] | ^^^^^^^^^ this item is private | = note: `#[warn(private_intra_doc_links)]` on by default = note: this link will resolve properly if you pass `--document-private-items` ``` Fixes the issue found in rust-lang#77249 (comment). r? ````@Manishearth```` Does anyone know why this additional step is necessary? It seems weird this has to be declared in 3 different places.

Recognize `private_intra_doc_links` as a lint Previously, trying to allow this would give another error! ``` warning: unknown lint: `private_intra_doc_links` --> private.rs:1:10 | 1 | #![allow(private_intra_doc_links)] | ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links` | = note: `#[warn(unknown_lints)]` on by default warning: public documentation for `DocMe` links to private item `DontDocMe` --> private.rs:2:11 | 2 | /// docs [DontDocMe] | ^^^^^^^^^ this item is private | = note: `#[warn(private_intra_doc_links)]` on by default = note: this link will resolve properly if you pass `--document-private-items` ``` Fixes the issue found in rust-lang#77249 (comment). r? `````@Manishearth````` Does anyone know why this additional step is necessary? It seems weird this has to be declared in 3 different places.

Recognize `private_intra_doc_links` as a lint Previously, trying to allow this would give another error! ``` warning: unknown lint: `private_intra_doc_links` --> private.rs:1:10 | 1 | #![allow(private_intra_doc_links)] | ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links` | = note: `#[warn(unknown_lints)]` on by default warning: public documentation for `DocMe` links to private item `DontDocMe` --> private.rs:2:11 | 2 | /// docs [DontDocMe] | ^^^^^^^^^ this item is private | = note: `#[warn(private_intra_doc_links)]` on by default = note: this link will resolve properly if you pass `--document-private-items` ``` Fixes the issue found in rust-lang#77249 (comment). r? ``````@Manishearth`````` Does anyone know why this additional step is necessary? It seems weird this has to be declared in 3 different places.

Recognize `private_intra_doc_links` as a lint Previously, trying to allow this would give another error! ``` warning: unknown lint: `private_intra_doc_links` --> private.rs:1:10 | 1 | #![allow(private_intra_doc_links)] | ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links` | = note: `#[warn(unknown_lints)]` on by default warning: public documentation for `DocMe` links to private item `DontDocMe` --> private.rs:2:11 | 2 | /// docs [DontDocMe] | ^^^^^^^^^ this item is private | = note: `#[warn(private_intra_doc_links)]` on by default = note: this link will resolve properly if you pass `--document-private-items` ``` Fixes the issue found in rust-lang#77249 (comment). r? ```````@Manishearth``````` Does anyone know why this additional step is necessary? It seems weird this has to be declared in 3 different places.

Recognize `private_intra_doc_links` as a lint Previously, trying to allow this would give another error! ``` warning: unknown lint: `private_intra_doc_links` --> private.rs:1:10 | 1 | #![allow(private_intra_doc_links)] | ^^^^^^^^^^^^^^^^^^^^^^^ help: did you mean: `broken_intra_doc_links` | = note: `#[warn(unknown_lints)]` on by default warning: public documentation for `DocMe` links to private item `DontDocMe` --> private.rs:2:11 | 2 | /// docs [DontDocMe] | ^^^^^^^^^ this item is private | = note: `#[warn(private_intra_doc_links)]` on by default = note: this link will resolve properly if you pass `--document-private-items` ``` Fixes the issue found in rust-lang#77249 (comment). r? ````````@Manishearth```````` Does anyone know why this additional step is necessary? It seems weird this has to be declared in 3 different places.

jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-visibility Area: Visibility / privacy A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name labels Sep 27, 2020

rust-highfive assigned Manishearth Sep 27, 2020

This comment has been minimized.
Sign in to view

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

jyn514 added the A-lints Area: Lints (warnings about flaws in source code) such as unused_mut. label Sep 27, 2020

jyn514 force-pushed the private-links branch 2 times, most recently from 3f20adb to 3fdad10Compare September 27, 2020 04:10

Manishearth approved these changes Sep 27, 2020
View reviewed changes

Comment threadcompiler/rustc_session/src/lint/builtin.rs Outdated

jyn514 force-pushed the private-links branch from 3fdad10 to 51aab59Compare September 27, 2020 14:07

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 Sep 27, 2020

Add documentation for private_intra_doc_links
80ffaed

jyn514 force-pushed the private-links branch from 51aab59 to 80ffaedCompare September 27, 2020 14:44

This was referenced Sep 27, 2020
Rollup of 8 pull requests #77269
Closed
Rollup of 7 pull requests #77272
Merged

bors merged commit 2a90d31 into rust-lang:masterSep 27, 2020

rustbot added this to the 1.48.0 milestone Sep 27, 2020

jyn514 deleted the private-links branch September 27, 2020 19:38

jyn514 mentioned this pull request Oct 19, 2020
Recognize private_intra_doc_links as a lint #78114
Merged

Navigation Menu

Uh oh!

Uh oh!

Separate `private_intra_doc_links` and `broken_intra_doc_links` into separate lints - #77249

Separate `private_intra_doc_links` and `broken_intra_doc_links` into separate lints#77249
bors merged 2 commits into
rust-lang:masterfrom
jyn514:private-links

jyn514 commented Sep 27, 2020

Uh oh!

This comment has been minimized.

Uh oh!

Manishearth commented Sep 27, 2020

Uh oh!

bors commented Sep 27, 2020

Uh oh!

jyn514 commented Sep 27, 2020

Uh oh!

jyn514 commented Sep 27, 2020

Uh oh!

bors commented Sep 27, 2020

Uh oh!

tiziano88 commented Oct 19, 2020

Uh oh!

jyn514 commented Oct 19, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Uh oh!

Conversation

jyn514 commented Sep 27, 2020

Uh oh!

This comment has been minimized.

Uh oh!

Manishearth commented Sep 27, 2020

Uh oh!

bors commented Sep 27, 2020

Uh oh!

jyn514 commented Sep 27, 2020

Uh oh!

jyn514 commented Sep 27, 2020

Uh oh!

bors commented Sep 27, 2020

Uh oh!

tiziano88 commented Oct 19, 2020

Uh oh!

jyn514 commented Oct 19, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants