pages/*: apply consistent subcommand note, style-guide: update subcommand note (#24274)

* pages/*: use consistent format for subcommand documentation notes

* gcrane: format command name as code

* pages/*: drop "etc." from subcommand notes whose lists are complete

* style-guide: document when to use "etc." in subcommand notes
This commit is contained in:
Sebastiaan Speck
2026-09-29 11:43:23 +05:30
committed by GitHub
parent 796c614f9e
commit e84d9301b8
23 changed files with 30 additions and 23 deletions
+8 -1
View File
@@ -303,6 +303,13 @@ When linking pages to websites that have locale settings like the Microsoft Lear
> Some subcommands such as `commit`, `add`, `branch`, `switch`, `push`, etc. have their own usage documentation.
```
- If the listed subcommands are not all the subcommands that have their own page, end the list with `etc.`. If every subcommand with its own page is listed, omit `etc.` and join the last item with `and` instead:
```md
> Some subcommands such as `append` and `filter` have their own usage documentation.
> Some subcommands such as `delete`, `list`, and `set` have their own usage documentation.
```
#### Heading order
The heading should adhere to the following order:
@@ -311,7 +318,7 @@ The heading should adhere to the following order:
> Short description of the functionality.
> Further clarification of the functionality.
> Note: Any note for the usage.
> Some subcommands such as `subcommand1`, `subcommand2` have their own usage documentation.
> Some subcommands such as `subcommand1`, `subcommand2`, etc. have their own usage documentation.
> See also: `command`.
> More information: <https://example.com>.
```
+1 -1
View File
@@ -1,7 +1,7 @@
# bun pm
> A set of utilities for working with Bun's package manager.
> Some subcommands such as `pack`, `pkg` have their own usage documentation.
> Some subcommands such as `pack`, `pkg`, etc. have their own usage documentation.
> More information: <https://bun.com/docs/pm/cli/pm>.
- Create a tarball of the current workspace:
+1 -1
View File
@@ -1,7 +1,7 @@
# cradle
> The Cradle PHP framework.
> Some subcommands such as `install` and `package` have their own usage documentation.
> Some subcommands such as `install`, `package`, etc. have their own usage documentation.
> More information: <https://cradlephp.github.io/docs/3.B.-Reference-Command-Line-Tools.html>.
- Install Cradle components (prompts for additional info):
+1 -1
View File
@@ -1,7 +1,7 @@
# docker compose
> Run and manage multi container Docker applications.
> Some subcommands such as `up`, `down`, `logs`, `stop` have their own usage documentation.
> Some subcommands such as `up`, `down`, `logs`, `stop`, etc. have their own usage documentation.
> More information: <https://docs.docker.com/reference/cli/docker/compose/>.
- List all running containers:
+1 -1
View File
@@ -1,7 +1,7 @@
# docker
> Manage Docker containers and images.
> Some subcommands such as `container` and `image` have their own usage documentation.
> Some subcommands such as `container`, `image`, etc. have their own usage documentation.
> More information: <https://docs.docker.com/reference/cli/docker/>.
- List all Docker containers (running and stopped):
+1 -1
View File
@@ -1,7 +1,7 @@
# doppler
> Manage environment variables across different environments.
> Some subcommands such as `run` and `secrets` have their own usage documentation.
> Some subcommands such as `run`, `secrets`, etc. have their own usage documentation.
> More information: <https://docs.doppler.com/docs/cli>.
- Set up Doppler project and configuration in current directory:
+1 -1
View File
@@ -1,7 +1,7 @@
# gcloud
> The official CLI tool for Google Cloud Platform.
> Some subcommands such as `app` and `init` have their own usage documentation.
> Some subcommands such as `app`, `init`, etc. have their own usage documentation.
> More information: <https://docs.cloud.google.com/sdk/gcloud>.
- List all properties in one's active configuration:
+1 -1
View File
@@ -2,7 +2,7 @@
> Container images managing tool.
> This tool implements a superset of the `crane` commands, with additional commands that are specific to Google Container Registry (`gcr.io`).
> Some subcommands such as `copy`, `gc`, `help`, `ls` have their own usage documentation.
> Some subcommands such as `copy`, `gc`, `help`, `ls`, etc. have their own usage documentation.
> See also: `crane`.
> More information: <https://github.com/google/go-containerregistry/blob/main/cmd/gcrane/README.md>.
+1 -1
View File
@@ -1,7 +1,7 @@
# jj config
> Manage config options.
> Some subcommands such as `edit`, `get`, `list`, `path`, `set`, `unset` have their own usage documentation.
> Some subcommands such as `edit`, `get`, `list`, `path`, `set`, and `unset` have their own usage documentation.
> More information: <https://docs.jj-vcs.dev/latest/cli-reference/#jj-config>.
- Start an editor on the user-level config file:
+1 -1
View File
@@ -1,7 +1,7 @@
# jj file
> Manage and inspect files in a `jj` repository.
> Some subcommands such as `annotate`, `show`, `track`, `untrack` have their own usage documentation.
> Some subcommands such as `annotate`, `show`, `track`, `untrack`, etc. have their own usage documentation.
> More information: <https://docs.jj-vcs.dev/latest/cli-reference/#jj-file>.
- List files tracked in the working copy:
+1 -1
View File
@@ -1,7 +1,7 @@
# jj operation
> Work with the operation log of a `jj` repository.
> Some subcommands such as `abandon`, `diff`, `integrate`, `log`, `restore`, `revert`, `show` have their own usage documentation.
> Some subcommands such as `abandon`, `diff`, `integrate`, `log`, `restore`, `revert`, and `show` have their own usage documentation.
> More information: <https://docs.jj-vcs.dev/latest/cli-reference/#jj-operation>.
- Show operation log:
+1 -1
View File
@@ -1,7 +1,7 @@
# jj tag
> Manage tags in a `jj` repository.
> Some subcommands such as `delete`, `list`, `set` have their own usage documentation.
> Some subcommands such as `delete`, `list`, and `set` have their own usage documentation.
> More information: <https://docs.jj-vcs.dev/latest/cli-reference/#jj-tag>.
- Create a tag pointing to the current working copy revision:
+1 -1
View File
@@ -1,7 +1,7 @@
# nh
> Modern helper utility tool for the Nix/NixOS ecosystem.
> Some subcommands such as `os`, `home`, `clean`, `search` have their own usage documentation.
> Some subcommands such as `os`, `home`, `clean`, and `search` have their own usage documentation.
> More information: <https://github.com/nix-community/nh#usage>.
- Build and switch to a specified NixOS flake configuration:
+1 -1
View File
@@ -1,7 +1,7 @@
# nix flake
> Manage Nix flakes.
> Some subcommands such as `init`, `show`, `info` have their own usage documentation.
> Some subcommands such as `init`, `show`, and `info` have their own usage documentation.
> More information: <https://nix.dev/manual/nix/stable/command-ref/new-cli/nix3-flake.html>.
- Update all inputs (dependencies) of the flake in the current directory:
+1 -1
View File
@@ -1,7 +1,7 @@
# sfdk
> Frontend of the Sailfish SDK.
> Some subcommands such as `init`, `build-init`, `device` have their own usage documentation.
> Some subcommands such as `init`, `build-init`, `device`, etc. have their own usage documentation.
> More information: <https://github.com/sailfishos/sailfish-qtcreator/blob/master/share/qtcreator/sfdk/modules/10-general/doc/module.adoc>.
- Set up the current environment for building for SailfishOS with a specific version and architecture target:
+1 -1
View File
@@ -1,7 +1,7 @@
# uv
> A fast Python package and project manager.
> Some subcommands such as `tool` and `python` have their own usage documentation.
> Some subcommands such as `tool`, `python`, etc. have their own usage documentation.
> More information: <https://docs.astral.sh/uv/reference/cli/>.
- Create a new Python project in the current directory:
+1 -1
View File
@@ -1,7 +1,7 @@
# wacli
> WhatsApp command-line client for sending messages, managing chats, and contacts.
> Some subcommands such as `send`, `messages`, `chats`, and `contacts` have their own usage documentation.
> Some subcommands such as `send`, `messages`, `chats`, `contacts`, etc. have their own usage documentation.
> More information: <https://wacli.sh/>.
- Authenticate via QR code:
+1 -1
View File
@@ -1,7 +1,7 @@
# yadm
> A dotfiles manager that works by using `git`.
> Some subcommands such as `init`, `clone`, `push`, and `pull` have their own usage documentation.
> Some subcommands such as `init`, `clone`, `push`, `pull`, etc. have their own usage documentation.
> More information: <https://yadm.io/docs/overview>.
- Override yadm's configuration directory:
+1 -1
View File
@@ -1,7 +1,7 @@
# apptainer
> Manage containers for HPC and scientific computing.
> Some subcommands such as `build`, `pull`, and `push` have their own usage documentation.
> Some subcommands such as `build`, `pull`, `push`, etc. have their own usage documentation.
> More information: <https://apptainer.org/docs/user/main/cli.html>.
- Download a container from Docker Hub:
+1 -1
View File
@@ -1,7 +1,7 @@
# b4
> A tool for working with patches and pull requests in a public-inbox archive.
> Some subcommands such as `am`, `shazam`, `prep`, `send` have their own usage documentation.
> Some subcommands such as `am`, `shazam`, `prep`, and `send` have their own usage documentation.
> More information: <https://manned.org/b4>.
- Retrieve a thread from a public-inbox archive and save as an mbox file:
+1 -1
View File
@@ -1,7 +1,7 @@
# systemctl
> Control the systemd system and service manager.
> Some subcommands such as `disable`, `status`, `reboot` etc. have their own usage documentation.
> Some subcommands such as `disable`, `status`, `reboot`, etc. have their own usage documentation.
> More information: <https://www.freedesktop.org/software/systemd/man/latest/systemctl.html>.
- Show all running services:
+1 -1
View File
@@ -1,7 +1,7 @@
# choco
> The Chocolatey package manager.
> Some subcommands such as `install`, `upgrade`, `pin` have their own usage documentation.
> Some subcommands such as `install`, `upgrade`, `pin`, etc. have their own usage documentation.
> More information: <https://docs.chocolatey.org/en-us/choco/commands/>.
- Install a package:
+1 -1
View File
@@ -3,7 +3,7 @@
> Analyze and fix common problems in Microsoft 365 Enterprise installations.
> Formerly Microsoft Support and Recovery Assistant (SaRA), command-line version (`SaRAcmd.exe`).
> Note: This command is deprecated, use the GUI troubleshooters available within Windows Settings instead. It is not related to PowerShell (`Get-Help`).
> Some subcommands such as `OutlookCalendarCheckTask`, `ExpertExperienceAdminTask` have their own usage documentation.
> Some subcommands such as `OutlookCalendarCheckTask`, `ExpertExperienceAdminTask`, etc. have their own usage documentation.
> More information: <https://learn.microsoft.com/troubleshoot/microsoft-365/admin/miscellaneous/get-help-command-line-overview>.
- View documentation for PowerShell's `Get-Help` command: