Skip to content

stable Rustdoc Book suggests missing_doc_code_examples, which is unstable #109601

Closed
@peter-lyons-kehl

Description

@peter-lyons-kehl

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.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-discussionCategory: Discussion or questions that doesn't represent real issues.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions