diff options
| author | bors <bors@rust-lang.org> | 2023-03-26 12:05:38 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2023-03-26 12:05:38 +0000 |
| commit | 89c2e3d3d75486e52473de3ae38f0ca6efeffef2 (patch) | |
| tree | 07df5b9bb2675e15c5ecc5e4d55cc379f1cdecd7 /src/doc | |
| parent | 2420bd34ba68a625840022de2a56aec228500359 (diff) | |
| parent | 4aa4ce6ee26045f74f28d6a5067d01bf54221616 (diff) | |
| download | rust-89c2e3d3d75486e52473de3ae38f0ca6efeffef2.tar.gz rust-89c2e3d3d75486e52473de3ae38f0ca6efeffef2.zip | |
Auto merge of #109626 - matthiaskrgr:rollup-k0y7bdd, r=matthiaskrgr
Rollup of 6 pull requests Successful merges: - #109007 (rustdoc: skip `// some variants omitted` if enum is `#[non_exhaustive]`) - #109593 (Rustdoc Book refer to rustdoc::missing_doc_code_examples. Fixes #109592.) - #109595 (Improve "Auto-hide trait implementation documentation" GUI test) - #109619 (Still-further-specializable projections are ambiguous in new solver) - #109620 (Correct typo (`back_box` -> `black_box`)) - #109621 (Refactor: `VariantIdx::from_u32(0)` -> `FIRST_VARIANT`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Diffstat (limited to 'src/doc')
| -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. |