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

Improve display of const unstable display feature info #135830

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Jan 21, 2025

Fixes #131618.

It looks like this:

image

And like this for methods:

image

You can check it online here.

r? @notriddle

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jan 21, 2025
@GuillaumeGomez GuillaumeGomez changed the title Const unstable item info Improve display of const unstable display feature info Jan 21, 2025
@notriddle
Copy link
Contributor

If this works with methods, can you add an example and test case for that? Or, if not, mention that it doesn't work in the PR?

@GuillaumeGomez
Copy link
Member Author

Same code for both but you're right, better ensure it.

@GuillaumeGomez GuillaumeGomez force-pushed the const-unstable-item-info branch from b77b18a to a6bbf15 Compare January 21, 2025 20:06
@GuillaumeGomez
Copy link
Member Author

Extended test to check on methods as well and added screenshot.

@notriddle notriddle added T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. and removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jan 21, 2025
@notriddle
Copy link
Contributor

@rfcbot poll

@rfcbot
Copy link

rfcbot commented Jan 21, 2025

Team member @notriddle has asked teams: T-rustdoc-frontend, for consensus on:

@Nemo157
Copy link
Member

Nemo157 commented Jan 22, 2025

This seems a little too similar to normal unstable API annotations to me. Skimming the docs I think I would miss the const word and just overlook the method as unstable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rustdoc: the required const feature gate is not shown
5 participants