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

pages*: remove tldr command from "See also" #12354

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

Conversation

vitorhcl
Copy link
Member

These pages are not following the "See also" standard ("See also: COMMAND_NAME").

@github-actions github-actions bot added the page edit Changes to an existing page(s). label Feb 24, 2024
@@ -1,7 +1,6 @@
# rustup toolchain

> Manage Rust toolchains.
> See `rustup help toolchain` for more information about toolchains.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should stay in the description. This command outputs information about Rust toolchains in general, and "Display help" kind of implies that it's just the usage of rustup toolchain.

Many `rustup` commands deal with *toolchains*, a single
    installation of the Rust compiler. `rustup` supports multiple
    types of toolchains. The most basic track the official release
    channels: 'stable', 'beta' and 'nightly'; but `rustup` can also
    install toolchains from the official archives, for alternate host
    platforms, and from local builds.

    Standard release channel toolchain names have the following form:

        <channel>[-<date>][-<host>]

        <channel>       = stable|beta|nightly|<major.minor>|<major.minor.patch>
        <date>          = YYYY-MM-DD
        <host>          = <target-triple>

    'channel' is a named release channel, a major and minor version
    number such as `1.42`, or a fully specified version number, such
    as `1.42.0`. Channel names can be optionally appended with an
    archive date, as in `nightly-2014-12-18`, in which case the
    toolchain is downloaded from the archive for that date.

    The host may be specified as a target triple. This is most useful
    for installing a 32-bit compiler on a 64-bit platform, or for
    installing the [MSVC-based toolchain] on Windows. For example:

        $ rustup toolchain install stable-x86_64-pc-windows-msvc

    For convenience, omitted elements of the target triple will be
    inferred, so the above could be written:

        $ rustup toolchain install stable-msvc

    The `rustup default` command may be used to both install and set
    the desired toolchain as default in a single command:

        $ rustup default stable-msvc

    rustup can also manage symlinked local toolchain builds, which are
    often used for developing Rust itself. For more information see
    `rustup toolchain help link`.

Copy link
Member

@kbdharun kbdharun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution.

LGTM, after the above suggestion.

@@ -1,7 +1,7 @@
# age

> A simple, modern and secure file encryption tool.
> See `age-keygen` for how to generate key pairs.
> See also: `age-keygen`, for generating key pairs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's wrong with the old way of saying it? In my opinion, using "See also" everywhere makes it less readable, especially when there are multiple, semicolon-separated pages being referenced.

I know this was standardized in the style guide, but I still want to discuss it.

How about using "See also: command1, command2" when there is no additional description, and "See command for ..." otherwise?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about using "See also: command1, command2" when there is no additional description, and "See command for ..." otherwise?

Would be a good solution imo

@sebastiaanspeck
Copy link
Member

@vitorhcl any update on this?

@vitorhcl
Copy link
Member Author

vitorhcl commented May 3, 2024

@vitorhcl any update on this?

The discussion moved to the ipcs PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants