mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b9906aca5a
rust/tests/ui/doc_errors.stderr

47 lines
1.8 KiB
Plaintext
Raw Normal View History

Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
error: docs for function returning `Result` missing `# Errors` section
update most tests to 2021 edition
2021-10-23 02:42:52 -05:00
--> $DIR/doc_errors.rs:7:1
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
|
shrink `missing_{safety,errors,panics}_doc` spans
2022-11-02 06:47:46 -05:00
LL | pub fn pub_fn_missing_errors_header() -> Result<(), ()> {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
|
= note: `-D clippy::missing-errors-doc` implied by `-D warnings`
error: docs for function returning `Result` missing `# Errors` section
Automatic generation of error annotations for ui tests
2023-07-28 14:35:48 -05:00
--> $DIR/doc_errors.rs:13:1
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
|
shrink `missing_{safety,errors,panics}_doc` spans
2022-11-02 06:47:46 -05:00
LL | pub async fn async_pub_fn_missing_errors_header() -> Result<(), ()> {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add tests and improve checks.
2020-02-16 18:17:14 -06:00
error: docs for function returning `Result` missing `# Errors` section
Automatic generation of error annotations for ui tests
2023-07-28 14:35:48 -05:00
--> $DIR/doc_errors.rs:19:1
Add tests and improve checks.
2020-02-16 18:17:14 -06:00
|
shrink `missing_{safety,errors,panics}_doc` spans
2022-11-02 06:47:46 -05:00
LL | pub fn pub_fn_returning_io_result() -> io::Result<()> {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
error: docs for function returning `Result` missing `# Errors` section
Automatic generation of error annotations for ui tests
2023-07-28 14:35:48 -05:00
--> $DIR/doc_errors.rs:25:1
Add tests and improve checks.
2020-02-16 18:17:14 -06:00
|
shrink `missing_{safety,errors,panics}_doc` spans
2022-11-02 06:47:46 -05:00
LL | pub async fn async_pub_fn_returning_io_result() -> io::Result<()> {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add tests and improve checks.
2020-02-16 18:17:14 -06:00
error: docs for function returning `Result` missing `# Errors` section
Automatic generation of error annotations for ui tests
2023-07-28 14:35:48 -05:00
--> $DIR/doc_errors.rs:56:5
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
|
shrink `missing_{safety,errors,panics}_doc` spans
2022-11-02 06:47:46 -05:00
LL | pub fn pub_method_missing_errors_header() -> Result<(), ()> {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
error: docs for function returning `Result` missing `# Errors` section
Automatic generation of error annotations for ui tests
2023-07-28 14:35:48 -05:00
--> $DIR/doc_errors.rs:62:5
Add tests and improve checks.
2020-02-16 18:17:14 -06:00
|
shrink `missing_{safety,errors,panics}_doc` spans
2022-11-02 06:47:46 -05:00
LL | pub async fn async_pub_method_missing_errors_header() -> Result<(), ()> {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add tests and improve checks.
2020-02-16 18:17:14 -06:00
error: docs for function returning `Result` missing `# Errors` section
Automatic generation of error annotations for ui tests
2023-07-28 14:35:48 -05:00
--> $DIR/doc_errors.rs:92:5
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
|
LL | fn trait_method_missing_errors_header() -> Result<(), ()>;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add tests and improve checks.
2020-02-16 18:17:14 -06:00
error: aborting due to 7 previous errors
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.
2019-12-05 18:00:23 -06:00
Reference in New Issue Copy Permalink