Skip to content

Should format_args_nl! be #[doc(hidden)] ? #93904

Closed
@SimonSapin

Description

@SimonSapin
Contributor

Initial title: format_args_nl! should link to format_args! where they mention it


https://doc.rust-lang.org/nightly/std/macro.format_args_nl.html currently contains:

Same as format_args, but adds a newline in the end.

It would be nicer as:

Same as format_args, but adds a newline in the end.

… although I also find #87410 which made it #[doc(hidden)]. It looks like that was undone at some point?

Activity

added
E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
C-bugCategory: This is a bug.
T-libsRelevant to the library team, which will review and decide on the PR/issue.
Libs-SmallLibs issues that are considered "small" or self-contained
on Feb 11, 2022
name1e5s

name1e5s commented on Feb 11, 2022

@name1e5s
Contributor

It seems that #[doc(hidden)] is removed in #92456

name1e5s

name1e5s commented on Feb 11, 2022

@name1e5s
Contributor

@rustbot claim

added 2 commits that reference this issue on Feb 12, 2022

Rollup merge of rust-lang#93930 - name1e5s:chore/docs, r=Mark-Simulacrum

4b567b7

Rollup merge of rust-lang#93930 - name1e5s:chore/docs, r=Mark-Simulacrum

2b7f3ee
SimonSapin

SimonSapin commented on Feb 13, 2022

@SimonSapin
ContributorAuthor

It seems that #[doc(hidden)] is removed in #92456

Was it intentional, though? The PR description says

use ::std::prelude::v1::derive; compiles on stable, so, AFAIK, there is no reason to have it be #[doc(hidden)].

But that does not apply to format_args_nl which has:

    #[unstable(
        feature = "format_args_nl",
        issue = "none",
        reason = "`format_args_nl` is only for internal \
                  language use and is subject to change"
    )]

CC @danielhenrymantilla

changed the title [-]format_args_nl! docs should link to format_args! where they mention it[/-] [+]Should format_args_nl! be #[doc(hidden)] ?[/+] on Feb 13, 2022

6 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Libs-SmallLibs issues that are considered "small" or self-containedT-libsRelevant to the library team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @SimonSapin@raindev@danielhenrymantilla@name1e5s@jyn514

    Issue actions

      Should format_args_nl! be #[doc(hidden)] ? · Issue #93904 · rust-lang/rust