mirror of
https://github.com/rust-lang/rust-clippy
synced 2024-12-24 03:53:20 +00:00
35e2027a35
The original message ("unsafe function's docs miss `# Safety` section")
reads quite awkwardly. I've changed it to "unsafe function's docs are missing
a `# Safety` section" to have it read better.
Signed-off-by: Paul R. Tagliamonte <paultag@gmail.com>
64 lines
2.1 KiB
Text
64 lines
2.1 KiB
Text
error: safe function's docs have unnecessary `# Safety` section
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:12:1
|
|
|
|
|
LL | fn you_dont_see_me() {
|
|
| ^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
note: the lint level is defined here
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:2:5
|
|
|
|
|
LL | clippy::unnecessary_safety_doc,
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: safe function's docs have unnecessary `# Safety` section
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:23:5
|
|
|
|
|
LL | pub fn only_crate_wide_accessible() -> Result<(), ()> {
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: docs for function returning `Result` missing `# Errors` section
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:23:5
|
|
|
|
|
LL | pub fn only_crate_wide_accessible() -> Result<(), ()> {
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
note: the lint level is defined here
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:3:5
|
|
|
|
|
LL | clippy::missing_errors_doc,
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: safe function's docs have unnecessary `# Safety` section
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:38:5
|
|
|
|
|
LL | fn private(&self) {
|
|
| ^^^^^^^^^^^^^^^^^
|
|
|
|
error: docs for function which may panic missing `# Panics` section
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:38:5
|
|
|
|
|
LL | fn private(&self) {
|
|
| ^^^^^^^^^^^^^^^^^
|
|
|
|
|
note: first possible panic found here
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:41:9
|
|
|
|
|
LL | panic!();
|
|
| ^^^^^^^^
|
|
note: the lint level is defined here
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:4:5
|
|
|
|
|
LL | clippy::missing_panics_doc
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: unsafe function's docs are missing a `# Safety` section
|
|
--> tests/ui-toml/private-doc-errors/doc_lints.rs:49:9
|
|
|
|
|
LL | pub unsafe fn f() {}
|
|
| ^^^^^^^^^^^^^^^^^
|
|
|
|
|
= note: `-D clippy::missing-safety-doc` implied by `-D warnings`
|
|
= help: to override `-D warnings` add `#[allow(clippy::missing_safety_doc)]`
|
|
|
|
error: aborting due to 6 previous errors
|
|
|