diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2023-03-26 08:39:26 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-26 08:39:26 +0200 |
| commit | 623c4c8881b14a0ad9e25380cdb2c3340f48fa74 (patch) | |
| tree | ae991cd421ff547f3c06293211daed9d5bfe38b3 | |
| parent | df25f1571635583e327414312aaf54ba4935d398 (diff) | |
| parent | 1491c6f3117749cbefd6d0dc9c425a64ecff4f8d (diff) | |
| download | rust-623c4c8881b14a0ad9e25380cdb2c3340f48fa74.tar.gz rust-623c4c8881b14a0ad9e25380cdb2c3340f48fa74.zip | |
Rollup merge of #109593 - coop-rs:missing_doc_code_examples, r=GuillaumeGomez
Rustdoc Book refer to rustdoc::missing_doc_code_examples. Fixes #109592. Fixes #109592. But, please see a related question at #109592 (item `2.`).
| -rw-r--r-- | src/doc/rustdoc/src/write-documentation/what-to-include.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/doc/rustdoc/src/write-documentation/what-to-include.md b/src/doc/rustdoc/src/write-documentation/what-to-include.md index e1e09aa4a8a..cf1e6a8d3ca 100644 --- a/src/doc/rustdoc/src/write-documentation/what-to-include.md +++ b/src/doc/rustdoc/src/write-documentation/what-to-include.md @@ -39,7 +39,7 @@ warning: 1 warning emitted As a library author, adding the lint `#![deny(missing_docs)]` is a great way to ensure the project does not drift away from being documented well, and `#![warn(missing_docs)]` is a good way to move towards comprehensive -documentation. In addition to docs, `#![deny(missing_doc_code_examples)]` +documentation. In addition to docs, `#![deny(rustdoc::missing_doc_code_examples)]` ensures each function contains a usage example. In our example above, the warning is resolved by adding crate level documentation. |
