ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

style-guide: add help and version commands section (#11854) 

* style-guide: add help and version commands section

* style-guide: minor fixes to help & version command section wording

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

---------

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
pull/23/head
Vitor Henrique 2023-12-27 06:43:32 -03:00 committed by GitHub
parent d7f15fc4f6
commit 793d2a47c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
contributing-guides/style-guide.md
View File

@ -373,6 +373,11 @@ Additionally, if the link is related to PowerShell command documentation, remove
- Use <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/select-string> instead of <https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/select-string?view=powershell-7.4>.
- Use <https://learn.microsoft.com/powershell/module/powershellget/install-module> instead of <https://learn.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershellget-1.x>.
## Help and version commands
- We generally place the help and version commands at the **last part of the page** to highlight more practical commands at the beginning of the page.
- For consistency, we prefer generic wording `Display help` and `Display version` for these commands.
## Language-Specific Rules
### Chinese-Specific Rules