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

vitorhcl · 2024-02-24T23:05:27Z

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

acuteenvy · 2024-02-25T01:03:32Z

pages/common/rustup-toolchain.md

@@ -1,7 +1,6 @@
 # rustup toolchain

 > Manage Rust toolchains.
-> See `rustup help toolchain` for more information about toolchains.


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`.

kbdharun

Thanks for your contribution.

LGTM, after the above suggestion.

acuteenvy · 2024-02-25T18:24:57Z

pages/common/age.md

@@ -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.


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?

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

Would be a good solution imo

Suggested change

> See also: `age-keygen`, for generating key pairs.

> See also: `age-keygen` for generating key pairs.

sebastiaanspeck · 2024-05-03T00:58:34Z

@vitorhcl any update on this?

vitorhcl · 2024-05-03T01:06:37Z

@vitorhcl any update on this?

The discussion moved to the ipcs PR.

sebastiaanspeck · 2024-05-18T04:07:37Z

@vitorhcl any update on this?

The discussion moved to the ipcs PR.

Which is merged

kbdharun · 2024-05-18T04:16:02Z

pages/common/age.md

@@ -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.


Suggested change

> See also: `age-keygen`, for generating key pairs.

> See also: `age-keygen` for generating key pairs.

kbdharun · 2024-05-18T04:16:15Z

pages/common/git-fsck.md

@@ -1,7 +1,8 @@
 # git fsck

 > Verify the validity and connectivity of nodes in a Git repository index.
-> Does not make any modifications. See `git gc` for cleaning up dangling blobs.
+> Does not make any modifications.
+> See also: `git gc`, for cleaning up dangling blobs.


Suggested change

> See also: `git gc`, for cleaning up dangling blobs.

> See also: `git gc` for cleaning up dangling blobs.

kbdharun · 2024-05-18T04:22:11Z

pages/common/nix3-build.md

@@ -1,7 +1,7 @@
 # nix build

 > Build a Nix expression (downloading from the cache when possible).
-> See also: `tldr nix-build`. See `tldr nix3 flake` for information about flakes.
+> See also: `nix-build`; `nix3 flake`, for information about flakes.


Suggested change

> See also: `nix-build`; `nix3 flake`, for information about flakes.

> See also: `nix-build` for information about traditional Nix builds from expressions, `nix3 flake` for information about flakes.

kbdharun · 2024-05-18T04:22:21Z

pages/common/nix3-registry.md

@@ -1,7 +1,7 @@
 # nix registry

 > Manage a Nix flake registry.
-> See `tldr nix3 flake` for information about flakes.
+> See also: `nix3 flake`, for information about flakes.


Suggested change

> See also: `nix3 flake`, for information about flakes.

> See also: `nix3 flake` for information about flakes.

kbdharun · 2024-05-18T04:22:29Z

pages/common/nix3-run.md

@@ -1,7 +1,7 @@
 # nix run

 > Run an application from a Nix flake.
-> See `tldr nix3 flake` for information about flakes.
+> See also: `nix3 flake`, for information about flakes.


Suggested change

> See also: `nix3 flake`, for information about flakes.

> See also: `nix3 flake` for information about flakes.

kbdharun · 2024-05-18T04:22:40Z

pages/common/nix3-search.md

@@ -1,7 +1,7 @@
 # nix search

 > Search for packages in a Nix flake.
-> See `tldr nix3 flake` for information about flakes.
+> See also: `nix3 flake`, for information about flakes.


Suggested change

> See also: `nix3 flake`, for information about flakes.

> See also: `nix3 flake` for information about flakes.

kbdharun · 2024-05-18T04:23:06Z

pages/linux/mount.ddi.md

@@ -1,7 +1,7 @@
 # mount.ddi

 > Mount Discoverable Disk Images.
-> See `tldr systemd-dissect` for other commands relevant to DDIs.
+> See also: `systemd-dissect`, for other commands relevant to DDIs.


Suggested change

> See also: `systemd-dissect`, for other commands relevant to DDIs.

> See also: `systemd-dissect` for other commands relevant to DDIs.

kbdharun · 2024-05-18T04:23:51Z

pages/common/age-keygen.md

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

 > Generate `age` key pairs.
-> See `age` for how to encrypt/decrypt files.
+> See also: `age`, for encrypting/decrypting files.


Suggested change

> See also: `age`, for encrypting/decrypting files.

> See also: `age` for encrypting/decrypting files.

kbdharun · 2024-05-18T04:27:36Z

pages/common/nix3-shell.md

@@ -1,7 +1,7 @@
 # nix shell

 > Start a shell in which the specified packages are available.
-> See also: `tldr nix-shell`. See `tldr nix3 flake` for information about flakes.
+> See also: `nix-shell`; `nix3 flake`, for information about flakes.


Suggested change

> See also: `nix-shell`; `nix3 flake`, for information about flakes.

> See also: `nix-shell` for setting up development environments, `nix3 flake` for information about flakes.

pages*: remove tldr command from "See also"

123aee4

vitorhcl requested a review from cyqsimon as a code owner February 24, 2024 23:05

github-actions bot added the page edit Changes to an existing page(s). label Feb 24, 2024

pages.*: use standard style

1bfbd12

acuteenvy reviewed Feb 25, 2024

View reviewed changes

kbdharun approved these changes Feb 25, 2024

View reviewed changes

acuteenvy reviewed Feb 25, 2024

View reviewed changes

vitorhcl mentioned this pull request Mar 25, 2024

ipcs: fix POSIX page; linux/ipcs, lsipc: add pages #12553

Merged

5 tasks

kbdharun reviewed May 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

vitorhcl commented Feb 24, 2024

acuteenvy Feb 25, 2024

kbdharun left a comment

acuteenvy Feb 25, 2024

gutjuri Feb 27, 2024

kbdharun May 18, 2024

sebastiaanspeck commented May 3, 2024

vitorhcl commented May 3, 2024

sebastiaanspeck commented May 18, 2024

kbdharun May 18, 2024

kbdharun May 18, 2024

kbdharun May 18, 2024

kbdharun May 18, 2024

kbdharun May 18, 2024

kbdharun May 18, 2024

kbdharun May 18, 2024

kbdharun May 18, 2024

kbdharun May 18, 2024

	> See also: `age-keygen`, for generating key pairs.
	> See also: `age-keygen` for generating key pairs.

	> See also: `git gc`, for cleaning up dangling blobs.
	> See also: `git gc` for cleaning up dangling blobs.

	> See also: `nix-build`; `nix3 flake`, for information about flakes.
	> See also: `nix-build` for information about traditional Nix builds from expressions, `nix3 flake` for information about flakes.

	> See also: `nix3 flake`, for information about flakes.
	> See also: `nix3 flake` for information about flakes.

	> See also: `systemd-dissect`, for other commands relevant to DDIs.
	> See also: `systemd-dissect` for other commands relevant to DDIs.

	> See also: `age`, for encrypting/decrypting files.
	> See also: `age` for encrypting/decrypting files.

	> See also: `nix-shell`; `nix3 flake`, for information about flakes.
	> See also: `nix-shell` for setting up development environments, `nix3 flake` for information about flakes.

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

Are you sure you want to change the base?

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

Conversation

vitorhcl commented Feb 24, 2024

Choose a reason for hiding this comment

kbdharun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sebastiaanspeck commented May 3, 2024

vitorhcl commented May 3, 2024

sebastiaanspeck commented May 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment