Skip to content

Commit

Permalink
Rollup merge of #109593 - coop-rs:missing_doc_code_examples, r=Guilla…
Browse files Browse the repository at this point in the history
…umeGomez

Rustdoc Book refer to rustdoc::missing_doc_code_examples. Fixes #109592.

Fixes #109592. But, please see a related question at #109592 (item `2.`).
  • Loading branch information
matthiaskrgr committed Mar 26, 2023
2 parents df25f15 + 1491c6f commit 623c4c8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/doc/rustdoc/src/write-documentation/what-to-include.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 623c4c8

Please sign in to comment.