Skip to content

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

Closed
@LunaBorowska

Description

@LunaBorowska
Contributor

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.

Activity

jyn514

jyn514 commented on Oct 8, 2021

@jyn514
Member

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

added
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
on Oct 8, 2021
added
I-prioritizeIssue: Indicates that prioritization has been requested for this issue.
on Oct 8, 2021
added
T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
on Oct 8, 2021
added 2 commits that reference this issue on Oct 8, 2021

Rollup merge of rust-lang#89668 - Urgau:core-cfg-hide, r=GuillaumeGomez

66f5f12

Rollup merge of rust-lang#89668 - Urgau:core-cfg-hide, r=GuillaumeGomez

1c35968
removed
I-prioritizeIssue: Indicates that prioritization has been requested for this issue.
on Oct 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.regression-from-stable-to-nightlyPerformance or correctness regression from stable to nightly.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @LunaBorowska@apiraino@jyn514@camelid@rustbot

      Issue actions

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