Skip to content

rustdoc: Tracking issue for #[doc(cfg)] and automatically documented #[cfg]s #43781

@kennytm

Description

@kennytm

This is a tracking issue for RFC 3631.
The feature gate for this doc_cfg (doc_cfg_hide and doc_auto_cfg were removed in favor this overarching one).

Part of #1998.

About tracking issues

Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

Steps

  • Experimental implementation
  • Adjust documentation
  • Write an RFC
  • Update implementation to match RFC
  • Check performance impact on big crates
  • Stabilization PR (see instructions on forge):

Implementation history

Metadata

Metadata

Labels

A-attributesArea: Attributes (`#[…]`, `#![…]`)A-cfgArea: `cfg` conditional compilationB-RFC-implementedBlocker: Approved by a merged RFC and implemented but not stabilized.B-unstableBlocker: Implemented in the nightly compiler and unstable.C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCF-doc_auto_cfg`#![feature(doc_auto_cfg)]`F-doc_cfg`#![feature(doc_cfg)]`S-tracking-needs-to-bakeStatus: The implementation is "complete" but it needs time to bake.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Type

No type

Projects

Status

Rejected/Not lang

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions