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.

Sign up for GitHub

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

Jump to bottom

rustdoc: intra-doc-links disambiguation warning doesn't listen to -Dwarnings #52784

Closed
Nemo157 opened this issue Jul 27, 2018 · 0 comments
Closed

rustdoc: intra-doc-links disambiguation warning doesn't listen to -Dwarnings #52784

Nemo157 opened this issue Jul 27, 2018 · 0 comments
Labels
A-diagnostics Area: Messages for errors, warnings, and lints T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Nemo157
Copy link
Member

Nemo157 commented Jul 27, 2018

I expected this to error out, but it didn't:

> RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps -p futures-util-preview
 Documenting futures-util-preview v0.3.0-alpha.1 (file:///Users/Nemo157/sources/futures-rs/futures-util)
warning: `empty` is both a type and a function
 --> futures-util/src/future/empty.rs:6:1
  |
6 | / /// A future which is never resolved.
7 | | ///
8 | | /// This future can be created with the [`empty`] function.
  | |___________________________________________________________^
  |
  = help: try `type@empty` if you want to select the type, or `empty()` if you want to select the function

[...]

    Finished dev [unoptimized + debuginfo] target(s) in 3.26s
@Nemo157 Nemo157 mentioned this issue Jul 27, 2018
Merged
@jonas-schievink jonas-schievink added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-diagnostics Area: Messages for errors, warnings, and lints labels Jan 27, 2019
@euclio euclio mentioned this issue Feb 28, 2019
Merged
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this issue Mar 14, 2019
@Mark-Simulacrum
Rollup merge of rust-lang#58824 - euclio:intra-link-ambiguity, r=petr…
2d2a3f2 
…ochenkov

overhaul intra-doc-link ambiguity warning

Fixes rust-lang#52784.

- Makes the warning part of the `intra_doc_link_resolution_failure`
lint.
- Tightens the span to just the ambiguous link.
- Reports ambiguities across all three namespaces.
- Uses structured suggestions for disambiguation.
- Adds a test for the warnings.

r? @QuietMisdreavus
bors added a commit that referenced this issue Mar 18, 2019
@bors
Auto merge of #58824 - euclio:intra-link-ambiguity, r=petrochenkov
03dafa7 
overhaul intra-doc-link ambiguity warning

Fixes #52784.

- Makes the warning part of the `intra_doc_link_resolution_failure`
lint.
- Tightens the span to just the ambiguous link.
- Reports ambiguities across all three namespaces.
- Uses structured suggestions for disambiguation.
- Adds a test for the warnings.

r? @QuietMisdreavus
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-diagnostics Area: Messages for errors, warnings, and lints T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Nemo157 @jonas-schievink