DawnMagnet/tldr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

pages/*: standardize mentioning subcommands without the main command (#13626)

Browse Source 
* pages/*: standardize mentioning subcommands without the main command

* CONTRIBUTING: clarify that pages should only mention the subcommand
This commit is contained in:
Lena
2024-10-04 21:14:41 +02:00
committed by GitHub
parent 63d1867e67
commit b596b78b18
54 changed files with 55 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -141,7 +141,7 @@ You should always add a base page (e.g. `git`) that describes the program and ba
The following methods can be used to reference subcommands:
- You can add a note saying ``Some subcommands such as `example command` have their own usage documentation`` to the main page. (See the [subcommand reference](/contributing-guides/translation-templates/subcommand-mention.md) page for translation templates.)
- You can add a note saying ``Some subcommands such as `example command` have their own usage documentation`` to the main page. (See the [subcommand reference](/contributing-guides/translation-templates/subcommand-mention.md) page for translation templates). `example command` should only include the subcommand (e.g. `commit` instead of `git commit`).
- You can use ``See also: `command1`, `command2`.`` template to reference similar commands, aliases and subcommands.
- Alternatively, the whole page can be converted to reference the main subcommands.