user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve missing create level error message

Browse source
This commit is contained in:
James Barford-Evans 2025-10-08 09:45:10 +01:00
parent 4fd3181552
commit 2c1e796ed0
5 changed files with 20 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/librustdoc/core.rs
View file

@ -407,6 +407,9 @@ pub(crate) fn run_global_ctxt(
crate::lint::MISSING_CRATE_LEVEL_DOCS,
DocContext::as_local_hir_id(tcx, krate.module.item_id).unwrap(),
|lint| {
if let Some(local_def_id) = krate.module.item_id.as_local_def_id() {
lint.span(tcx.def_span(local_def_id));
}
lint.primary_message("no documentation found for this crate's top-level module");
lint.help(help);
},

4
tests/rustdoc-ui/lints/check.rs
View file

@ -2,7 +2,7 @@
//@ compile-flags: -Z unstable-options --check
//@ normalize-stderr: "nightly|beta|1\.[0-9][0-9]\.[0-9]" -> "$$CHANNEL"
#![feature(rustdoc_missing_doc_code_examples)]
#![feature(rustdoc_missing_doc_code_examples)] //~ WARN no documentation found for this crate's top-level module
//~^ WARN
#![warn(missing_docs)]
@ -12,5 +12,3 @@
pub fn foo() {}
//~^ WARN
//~^^ WARN
//~? WARN no documentation found for this crate's top-level module

9
tests/rustdoc-ui/lints/check.stderr
View file

@ -22,6 +22,15 @@ LL | pub fn foo() {}
| ^^^^^^^^^^^^
warning: no documentation found for this crate's top-level module
--> $DIR/check.rs:5:1
|
LL | / #![feature(rustdoc_missing_doc_code_examples)]
LL | |
LL | |
LL | | #![warn(missing_docs)]
... |
LL | | pub fn foo() {}
| |_______________^
|
= help: The following guide may be of use:
https://doc.rust-lang.org/$CHANNEL/rustdoc/how-to-write-documentation.html

4
tests/rustdoc-ui/lints/no-crate-level-doc-lint.rs
View file

@ -1,7 +1,5 @@
//@ normalize-stderr: "nightly|beta|1\.[0-9][0-9]\.[0-9]" -> "$$CHANNEL"
#![deny(rustdoc::missing_crate_level_docs)]
#![deny(rustdoc::missing_crate_level_docs)] //~ ERROR no documentation found for this crate's top-level module
//^~ NOTE defined here
pub fn foo() {}
//~? ERROR no documentation found for this crate's top-level module

6
tests/rustdoc-ui/lints/no-crate-level-doc-lint.stderr
View file

@ -1,4 +1,10 @@
error: no documentation found for this crate's top-level module
--> $DIR/no-crate-level-doc-lint.rs:2:1
|
LL | / #![deny(rustdoc::missing_crate_level_docs)]
... |
LL | | pub fn foo() {}
| |_______________^
|
= help: The following guide may be of use:
https://doc.rust-lang.org/$CHANNEL/rustdoc/how-to-write-documentation.html