Skip to content

rustdoc doesn't show that a trait bound is ~const #91187

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

Open
camelid opened this issue Nov 24, 2021 · 2 comments
Open

rustdoc doesn't show that a trait bound is ~const #91187

camelid opened this issue Nov 24, 2021 · 2 comments
Labels
A-const-eval Area: Constant evaluation, covers all const contexts (static, const fn, ...) C-bug Category: This is a bug. F-const_trait_impl `#![feature(const_trait_impl)]` 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

@camelid
Copy link
Member

camelid commented Nov 24, 2021

For example, see https://doc.rust-lang.org/nightly/std/intrinsics/fn.const_eval_select.html. The trait bounds for F and G each include ~const, and while the bounds themselves are shown, ~const is not.

@camelid camelid added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-const-fn C-bug Category: This is a bug. requires-nightly This issue requires a nightly compiler in some way. labels Nov 24, 2021
@inquisitivecrystal inquisitivecrystal added the F-const_trait_impl `#![feature(const_trait_impl)]` label Nov 26, 2021
@fee1-dead
Copy link
Member

Related: #92229 helped by not showing ~const Drop. We don't really have a policy for documenting experimental features in rustdoc, since const_trait_impl is not yet accepted and ~const is still provisional syntax, this issue is probably currently unactionable.

@fee1-dead
Copy link
Member

fee1-dead commented Sep 18, 2022

Coming back at this. Hiding const trait bounds was deliberate. const_trait_impl is provisional and its RfC was not approved. Showing an unstable syntax in rustdoc should be avoided.

@RalfJung RalfJung added A-const-eval Area: Constant evaluation, covers all const contexts (static, const fn, ...) and removed A-const-fn labels Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-const-eval Area: Constant evaluation, covers all const contexts (static, const fn, ...) C-bug Category: This is a bug. F-const_trait_impl `#![feature(const_trait_impl)]` 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

No branches or pull requests

4 participants