Skip to content

Core documentation shows "This is supported on non-crate feature miri-test-libstd or test or doctest only" annotation #89663

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.

Sign up for GitHub

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

Jump to bottom
Closed
KamilaBorowska opened this issue Oct 8, 2021 · 1 comment · Fixed by #89668
Closed

Core documentation shows "This is supported on non-crate feature miri-test-libstd or test or doctest only" annotation #89663

KamilaBorowska opened this issue Oct 8, 2021 · 1 comment · Fixed by #89668
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. regression-from-stable-to-nightly Performance or correctness regression from stable to nightly. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@KamilaBorowska
Copy link
Contributor

KamilaBorowska commented Oct 8, 2021 •
edited
Loading

https://doc.rust-lang.org/nightly/core/index.html shows this annotation:

This is supported on non-crate feature miri-test-libstd or test or doctest only.

This doesn't seem very useful for an end-user, and this annotation shows for every page in the documentation. This issue also affects alloc crate.
@jyn514
Copy link
Member

jyn514 commented Oct 8, 2021

@xfix the fix is to add #![doc(cfg_hide(miri-test-libstd))] to the crate root; it would be a good first PR :)

@jyn514 jyn514 added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. regression-from-stable-to-nightly Performance or correctness regression from stable to nightly. labels Oct 8, 2021
@rustbot rustbot added the I-prioritize Issue: Indicates that prioritization has been requested for this issue. label Oct 8, 2021
@Urgau Urgau mentioned this issue Oct 8, 2021
Merged
@apiraino apiraino added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 8, 2021
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Oct 8, 2021
@GuillaumeGomez
Rollup merge of rust-lang#89668 - Urgau:core-cfg-hide, r=GuillaumeGomez
66f5f12 
Cfg hide more conditions for core and alloc

Fixes rust-lang#89663

Before:
![image](https://user-images.githubusercontent.com/3616612/136572816-a7844ac7-dc2f-4d79-87b4-7f9766421a83.png)

After:
![image](https://user-images.githubusercontent.com/3616612/136572745-7d890726-8efd-4d74-83ac-ed06f4687741.png)

*Same for alloc*

r? `@GuillaumeGomez`
@bors bors closed this as completed in 1c35968 Oct 9, 2021
@camelid camelid removed the I-prioritize Issue: Indicates that prioritization has been requested for this issue. label Oct 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. regression-from-stable-to-nightly Performance or correctness regression from stable to nightly. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Cfg hide more conditions for core and alloc Urgau/rust
5 participants
@KamilaBorowska @apiraino @jyn514 @camelid @rustbot