dnrops
/
rust
mirror of https://github.com/rust-lang/rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #83762 - camelid:bare-urls-note, r=jyn514 

Add explanatory note to `bare_urls` lint

I think the lint is confusing otherwise since it doesn't fully explain
what the problem is.
This commit is contained in:
bors 2021-04-14 01:16:46 +00:00
parent 132b4e5d16 dbbbdf1097
commit d408fdd4a8
3 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/librustdoc/passes/bare_urls.rs
View File

@ -73,6 +73,7 @@ impl<'a, 'tcx> DocFolder for BareUrlsLinter<'a, 'tcx> {
.unwrap_or(item.span.inner()); .unwrap_or(item.span.inner());
cx.tcx.struct_span_lint_hir(crate::lint::BARE_URLS, hir_id, sp, |lint| { cx.tcx.struct_span_lint_hir(crate::lint::BARE_URLS, hir_id, sp, |lint| {
lint.build(msg) lint.build(msg)
.note("bare URLs are not automatically turned into clickable links")
.span_suggestion( .span_suggestion(
sp, sp,
"use an automatic link instead", "use an automatic link instead",

33
src/test/rustdoc-ui/bare-urls.stderr
View File

@ -9,102 +9,135 @@ note: the lint level is defined here
| |
LL | #![deny(rustdoc::bare_urls)] LL | #![deny(rustdoc::bare_urls)]
| ^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:7:5 --> $DIR/bare-urls.rs:7:5
| |
LL | /// https://somewhere.com/a LL | /// https://somewhere.com/a
| ^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a>` | ^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:9:5 --> $DIR/bare-urls.rs:9:5
| |
LL | /// https://www.somewhere.com LL | /// https://www.somewhere.com
| ^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://www.somewhere.com>` | ^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://www.somewhere.com>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:11:5 --> $DIR/bare-urls.rs:11:5
| |
LL | /// https://www.somewhere.com/a LL | /// https://www.somewhere.com/a
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://www.somewhere.com/a>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://www.somewhere.com/a>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:13:5 --> $DIR/bare-urls.rs:13:5
| |
LL | /// https://subdomain.example.com LL | /// https://subdomain.example.com
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://subdomain.example.com>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://subdomain.example.com>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:15:5 --> $DIR/bare-urls.rs:15:5
| |
LL | /// https://somewhere.com? LL | /// https://somewhere.com?
| ^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com?>` | ^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com?>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:17:5 --> $DIR/bare-urls.rs:17:5
| |
LL | /// https://somewhere.com/a? LL | /// https://somewhere.com/a?
| ^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a?>` | ^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a?>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:19:5 --> $DIR/bare-urls.rs:19:5
| |
LL | /// https://somewhere.com?hello=12 LL | /// https://somewhere.com?hello=12
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com?hello=12>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com?hello=12>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:21:5 --> $DIR/bare-urls.rs:21:5
| |
LL | /// https://somewhere.com/a?hello=12 LL | /// https://somewhere.com/a?hello=12
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a?hello=12>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a?hello=12>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:23:5 --> $DIR/bare-urls.rs:23:5
| |
LL | /// https://example.com?hello=12#xyz LL | /// https://example.com?hello=12#xyz
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://example.com?hello=12#xyz>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://example.com?hello=12#xyz>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:25:5 --> $DIR/bare-urls.rs:25:5
| |
LL | /// https://example.com/a?hello=12#xyz LL | /// https://example.com/a?hello=12#xyz
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://example.com/a?hello=12#xyz>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://example.com/a?hello=12#xyz>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:27:5 --> $DIR/bare-urls.rs:27:5
| |
LL | /// https://example.com#xyz LL | /// https://example.com#xyz
| ^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://example.com#xyz>` | ^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://example.com#xyz>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:29:5 --> $DIR/bare-urls.rs:29:5
| |
LL | /// https://example.com/a#xyz LL | /// https://example.com/a#xyz
| ^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://example.com/a#xyz>` | ^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://example.com/a#xyz>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:31:5 --> $DIR/bare-urls.rs:31:5
| |
LL | /// https://somewhere.com?hello=12&bye=11 LL | /// https://somewhere.com?hello=12&bye=11
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com?hello=12&bye=11>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com?hello=12&bye=11>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:33:5 --> $DIR/bare-urls.rs:33:5
| |
LL | /// https://somewhere.com/a?hello=12&bye=11 LL | /// https://somewhere.com/a?hello=12&bye=11
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a?hello=12&bye=11>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a?hello=12&bye=11>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:35:5 --> $DIR/bare-urls.rs:35:5
| |
LL | /// https://somewhere.com?hello=12&bye=11#xyz LL | /// https://somewhere.com?hello=12&bye=11#xyz
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com?hello=12&bye=11#xyz>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com?hello=12&bye=11#xyz>`
|
= note: bare URLs are not automatically turned into clickable links
error: this URL is not a hyperlink error: this URL is not a hyperlink
--> $DIR/bare-urls.rs:37:10 --> $DIR/bare-urls.rs:37:10
| |
LL | /// hey! https://somewhere.com/a?hello=12&bye=11#xyz LL | /// hey! https://somewhere.com/a?hello=12&bye=11#xyz
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a?hello=12&bye=11#xyz>` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://somewhere.com/a?hello=12&bye=11#xyz>`
|
= note: bare URLs are not automatically turned into clickable links
error: aborting due to 17 previous errors error: aborting due to 17 previous errors

1
src/test/rustdoc-ui/renamed-lint-still-applies.stderr
View File

@ -31,6 +31,7 @@ note: the lint level is defined here
| |
LL | #![deny(rustdoc::non_autolinks)] LL | #![deny(rustdoc::non_autolinks)]
| ^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^
= note: bare URLs are not automatically turned into clickable links
error: aborting due to 2 previous errors; 1 warning emitted error: aborting due to 2 previous errors; 1 warning emitted