-
-
Notifications
You must be signed in to change notification settings - Fork 14.2k
Description
Location
src/doc/rustdoc/src/write-documentation/what-to-include.md (https://doc.rust-lang.org/rustdoc/write-documentation/what-to-include.html)
Summary
Currently, missing_doc_code_examples lint is implemented on nightly and gated with #![feature(rustdoc_missing_doc_code_examples)]. However, the lint #![deny(missing_doc_code_examples)] is suggested in the stable version of Rustdoc Book, too - but without any mention that it's a nightly feature. Is it likely to get stabilized soon (so Rustdoc Book could stay as is)?
Otherwise, shouldn't we document that (and create an issue to remove such a note from the Rustdoc Book once the feature becomes stable)? If so, I'm happy to create an issue and a PR.
Or, should this be pulled out of stable Rustdoc Book until the feature is stabilized? Is there any recommended/de-facto practice for this?
(This issue is a follow up to #109592.)