mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
af8ee641a8
rust/tests/rustdoc-ui/check.stderr

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

62 lines
1.4 KiB
Plaintext
Raw Normal View History

Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
warning: missing documentation for the crate
rustdoc: link to stable/beta docs consistently in documentation ## User-facing changes - Intra-doc links to primitives that currently go to rust-lang.org/nightly/std/primitive.x.html will start going to channel that rustdoc was built with. Nightly will continue going to /nightly; Beta will link to /beta; stable compilers will link to /1.52.1 (or whatever version they were built as). - Cross-crate links from std to core currently go to /nightly unconditionally. They will start going to /1.52.0 on stable channels (but remain the same on nightly channels). - Intra-crate links from std to std (or core to core) currently go to the same URL they are hosted at; they will continue to do so. Notably, this is different from everything else because it can preserve the distinction between /stable and /1.52.0 by using relative links. Note that "links" includes both intra-doc links and rustdoc's own automatically generated hyperlinks. ## Implementation changes - Update the testsuite to allow linking to /beta and /1.52.1 in docs - Use an html_root_url for the standard library that's dependent on the channel This avoids linking to nightly docs on stable. - Update rustdoc to use channel-dependent links for primitives from an unknown crate - Set DOC_RUST_LANG_ORG_CHANNEL from bootstrap to ensure it's in sync - Include doc.rust-lang.org in the channel
2021-05-04 22:36:33 -05:00
--> $DIR/check.rs:5:1
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
|
Feature gate the rustdoc::missing_doc_code_examples lint
2022-09-12 13:10:35 -05:00
LL | / #![feature(rustdoc_missing_doc_code_examples)]
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
LL | |
LL | |
Feature gate the rustdoc::missing_doc_code_examples lint
2022-09-12 13:10:35 -05:00
LL | |
... |
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
LL | |
LL | | pub fn foo() {}
| |_______________^
|
note: the lint level is defined here
Feature gate the rustdoc::missing_doc_code_examples lint
2022-09-12 13:10:35 -05:00
--> $DIR/check.rs:9:9
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
|
LL | #![warn(missing_docs)]
| ^^^^^^^^^^^^
warning: missing documentation for a function
Only include stable lints in `rustdoc::all` group Including unstable lints in the lint group produces unintuitive behavior on stable (see #106289). Meanwhile, if we only included unstable lints on nightly and not on stable, we could end up with confusing bugs that were hard to compare across versions of Rust that lacked code changes. I think that only including stable lints in `rustdoc::all`, no matter the release channel, is the most intuitive option. Users can then control unstable lints individually, which is reasonable since they have to enable the feature gates individually anyway.
2022-12-30 19:09:19 -06:00
--> $DIR/check.rs:13:1
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
|
LL | pub fn foo() {}
| ^^^^^^^^^^^^
Address review comments - Move MISSING_CRATE_LEVEL_DOCS to rustdoc directly - Update documentation This also takes the opportunity to make the `no-crate-level-doc-lint` test more specific.
2021-01-18 00:14:01 -06:00
warning: no documentation found for this crate's top-level module
|
bless rustdoc-ui
2022-09-23 13:34:34 -05:00
= help: The following guide may be of use:
https://doc.rust-lang.org/$CHANNEL/rustdoc/how-to-write-documentation.html
Address review comments - Move MISSING_CRATE_LEVEL_DOCS to rustdoc directly - Update documentation This also takes the opportunity to make the `no-crate-level-doc-lint` test more specific.
2021-01-18 00:14:01 -06:00
note: the lint level is defined here
Only include stable lints in `rustdoc::all` group Including unstable lints in the lint group produces unintuitive behavior on stable (see #106289). Meanwhile, if we only included unstable lints on nightly and not on stable, we could end up with confusing bugs that were hard to compare across versions of Rust that lacked code changes. I think that only including stable lints in `rustdoc::all`, no matter the release channel, is the most intuitive option. Users can then control unstable lints individually, which is reasonable since they have to enable the feature gates individually anyway.
2022-12-30 19:09:19 -06:00
--> $DIR/check.rs:11:9
Address review comments - Move MISSING_CRATE_LEVEL_DOCS to rustdoc directly - Update documentation This also takes the opportunity to make the `no-crate-level-doc-lint` test more specific.
2021-01-18 00:14:01 -06:00
|
Rename `rustdoc` to `rustdoc::all` When rustdoc lints were changed to be tool lints, the `rustdoc` group was removed, leading to spurious warnings like ``` warning: unknown lint: `rustdoc` ``` The lint group still worked when rustdoc ran, since rustdoc added the group itself. This renames the group to `rustdoc::all` for consistency with `clippy::all` and the rest of the rustdoc lints.
2021-03-05 08:50:20 -06:00
LL | #![warn(rustdoc::all)]
| ^^^^^^^^^^^^
= note: `#[warn(rustdoc::missing_crate_level_docs)]` implied by `#[warn(rustdoc::all)]`
Address review comments - Move MISSING_CRATE_LEVEL_DOCS to rustdoc directly - Update documentation This also takes the opportunity to make the `no-crate-level-doc-lint` test more specific.
2021-01-18 00:14:01 -06:00
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
warning: missing code example in this documentation
rustdoc: link to stable/beta docs consistently in documentation ## User-facing changes - Intra-doc links to primitives that currently go to rust-lang.org/nightly/std/primitive.x.html will start going to channel that rustdoc was built with. Nightly will continue going to /nightly; Beta will link to /beta; stable compilers will link to /1.52.1 (or whatever version they were built as). - Cross-crate links from std to core currently go to /nightly unconditionally. They will start going to /1.52.0 on stable channels (but remain the same on nightly channels). - Intra-crate links from std to std (or core to core) currently go to the same URL they are hosted at; they will continue to do so. Notably, this is different from everything else because it can preserve the distinction between /stable and /1.52.0 by using relative links. Note that "links" includes both intra-doc links and rustdoc's own automatically generated hyperlinks. ## Implementation changes - Update the testsuite to allow linking to /beta and /1.52.1 in docs - Use an html_root_url for the standard library that's dependent on the channel This avoids linking to nightly docs on stable. - Update rustdoc to use channel-dependent links for primitives from an unknown crate - Set DOC_RUST_LANG_ORG_CHANNEL from bootstrap to ensure it's in sync - Include doc.rust-lang.org in the channel
2021-05-04 22:36:33 -05:00
--> $DIR/check.rs:5:1
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
|
Feature gate the rustdoc::missing_doc_code_examples lint
2022-09-12 13:10:35 -05:00
LL | / #![feature(rustdoc_missing_doc_code_examples)]
LL | |
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
LL | |
LL | |
Feature gate the rustdoc::missing_doc_code_examples lint
2022-09-12 13:10:35 -05:00
... |
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
LL | |
LL | | pub fn foo() {}
| |_______________^
|
Only include stable lints in `rustdoc::all` group Including unstable lints in the lint group produces unintuitive behavior on stable (see #106289). Meanwhile, if we only included unstable lints on nightly and not on stable, we could end up with confusing bugs that were hard to compare across versions of Rust that lacked code changes. I think that only including stable lints in `rustdoc::all`, no matter the release channel, is the most intuitive option. Users can then control unstable lints individually, which is reasonable since they have to enable the feature gates individually anyway.
2022-12-30 19:09:19 -06:00
note: the lint level is defined here
--> $DIR/check.rs:10:9
|
LL | #![warn(rustdoc::missing_doc_code_examples)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
warning: missing code example in this documentation
Only include stable lints in `rustdoc::all` group Including unstable lints in the lint group produces unintuitive behavior on stable (see #106289). Meanwhile, if we only included unstable lints on nightly and not on stable, we could end up with confusing bugs that were hard to compare across versions of Rust that lacked code changes. I think that only including stable lints in `rustdoc::all`, no matter the release channel, is the most intuitive option. Users can then control unstable lints individually, which is reasonable since they have to enable the feature gates individually anyway.
2022-12-30 19:09:19 -06:00
--> $DIR/check.rs:13:1
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
|
LL | pub fn foo() {}
| ^^^^^^^^^^^^^^^
Address review comments - Move MISSING_CRATE_LEVEL_DOCS to rustdoc directly - Update documentation This also takes the opportunity to make the `no-crate-level-doc-lint` test more specific.
2021-01-18 00:14:01 -06:00
warning: 5 warnings emitted
Add tests for rustdoc --check option
2020-11-12 07:58:07 -06:00
Reference in New Issue Copy Permalink