Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking Issue for #![feature(doc_primitive)] #88070

Closed
1 of 2 tasks
jyn514 opened this issue Aug 16, 2021 · 0 comments · Fixed by #109443
Closed
1 of 2 tasks

Tracking Issue for #![feature(doc_primitive)] #88070

jyn514 opened this issue Aug 16, 2021 · 0 comments · Fixed by #109443
Labels
C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. requires-nightly This issue requires a nightly compiler in some way. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jyn514
Copy link
Member

jyn514 commented Aug 16, 2021

This is a tracking issue for using #[doc(primitive)].
The feature gate for the issue is #![feature(doc_primitive)].

This feature is not meant to ever become stable. It is an implementation detail of the standard library.

Due to an oversight when releasing Rust 1.0, this could previously be used without a feature gate. That was a bug: this feature is not useful to anyone other than the standard library, and the behavior when multiple crates use doc(primitive) at once is unspecified (see "Breaking changes to doc(primitive)" in #87073). To avoid needlessly breaking crates, anyone using doc(primitive) without a feature gate will get a future-incompat warning instead of a hard error.

#[doc(primitive)] still has an effect even without the feature gate, but the behavior is still unspecified when more than one crate has the same primitive attribute. Once #87073 is merged and core starts documenting all primitives, it will be completely unspecified whether the new documentation is used or not.

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

Unresolved Questions

Does this need an edition to become a hard error? Crater hasn't found any crates using this attribute: #87050 (comment)

@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. requires-nightly This issue requires a nightly compiler in some way. labels Aug 16, 2021
@bors bors closed this as completed in 6c93c63 Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. requires-nightly This issue requires a nightly compiler in some way. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant