mirror of
https://github.com/tldr-pages/tldr.git
synced 2025-04-22 00:22:09 +02:00
style-guide: remove trailing whitespaces (#15802)
This commit is contained in:
parent
59e238fb5b
commit
36e24a9348
1 changed files with 10 additions and 10 deletions
|
@ -64,7 +64,7 @@ Example:
|
|||
`krita --fullscreen`
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> [!NOTE]\
|
||||
> The page's filename and title must match the command name exactly. The page title can be present in any case, whereas the page's Markdown filenames must be lowercase.
|
||||
|
||||
There is a linter that enforces the format above.
|
||||
|
@ -93,8 +93,8 @@ When documenting PowerShell commands, please take note of the following naming c
|
|||
- The page title/heading must be written as-is (matching the spelling intended by Microsoft or the PowerShell module author), such as `Invoke-WebRequest` instead of `invoke-webrequest`.
|
||||
- The command name and options in the examples should also be written as-is, such as `Command-Name {{input}} -CommandParameter {{value}}` instead of `command-name {{input}} -commandparameter {{value}}`.
|
||||
|
||||
Due to [various compatibility differences](https://learn.microsoft.com/powershell/scripting/whats-new/differences-from-windows-powershell) and removed Windows-specific commands in PowerShell 6.x, ensure that
|
||||
the command works on between **PowerShell 5.1** (aka. the "Legacy Windows PowerShell" as installed in Windows 10
|
||||
Due to [various compatibility differences](https://learn.microsoft.com/powershell/scripting/whats-new/differences-from-windows-powershell) and removed Windows-specific commands in PowerShell 6.x, ensure that
|
||||
the command works on between **PowerShell 5.1** (aka. the "Legacy Windows PowerShell" as installed in Windows 10
|
||||
and 11), and the **latest version of the Cross-Platform PowerShell** (formerly known as PowerShell Core).
|
||||
|
||||
Thus, if the command or its options are unavailable or contain different behaviors between each version, please kindly note them in the descriptions. For example:
|
||||
|
@ -165,7 +165,7 @@ Command Prompt command's tldr description, for example:
|
|||
`tldr set-location`
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> [!NOTE]\
|
||||
> The "View documentation of the equivalent PowerShell command" example is optional and must be excluded if the page already has the maximum number (8) of examples.
|
||||
|
||||
2. **Provides a new alias but only executable in PowerShell**, such as `ni` for `New-Item`. In this case, use the [standard alias template](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/alias-pages.md),
|
||||
|
@ -286,7 +286,7 @@ This can be resolved by inserting a comma before the "and" or "or" in the final
|
|||
|
||||
> Delete the Git branches, tags, and remotes.
|
||||
|
||||
> [!NOTE]
|
||||
> [!NOTE]\
|
||||
> Brand and project names can be capitalized in the description whenever applicable (e.g. use `A tool for interacting with a Git repository.` instead of ``A tool for interacting with a `git` repository.``).
|
||||
|
||||
### Special cases
|
||||
|
@ -336,11 +336,11 @@ For example, use:
|
|||
|
||||
#### Microsoft Learn links
|
||||
|
||||
When linking pages to the Microsoft Learn links, remove the locale from the address as the website will automatically redirect to the reader's preferred locale setting.
|
||||
When linking pages to the Microsoft Learn links, remove the locale from the address as the website will automatically redirect to the reader's preferred locale setting.
|
||||
For example, Use <https://learn.microsoft.com/windows-server/administration/windows-commands/cd> instead of
|
||||
<https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/cd>.
|
||||
|
||||
Additionally, if the link is related to PowerShell command documentation, remove the **documentation version indicator** (in which the version of PowerShell/module that the documentation is derived from), aka.
|
||||
Additionally, if the link is related to PowerShell command documentation, remove the **documentation version indicator** (in which the version of PowerShell/module that the documentation is derived from), aka.
|
||||
the part of the address that starts with `?view=`.
|
||||
|
||||
- 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>.
|
||||
|
@ -408,7 +408,7 @@ Short option mnemonics are optional hints that can be added to help users unders
|
|||
`slmgr.vbs /xpr`
|
||||
```
|
||||
|
||||
Note that, in the first example, the `[d]`, `[t]`, and `[i]` characters are enclosed with square brackets to indicate that the `/dti` option of the command is a combination of "display", "installation", and "ID", respectively.
|
||||
Note that, in the first example, the `[d]`, `[t]`, and `[i]` characters are enclosed with square brackets to indicate that the `/dti` option of the command is a combination of "display", "installation", and "ID", respectively.
|
||||
Group consecutive mnemonic characters under the same square brackets, for example: `e[xp]i[r]ation` instead of `e[x][p]i[r]ation`.
|
||||
|
||||
**Mnemonic characters must be written in a case-sensitive manner**, even when it is placed as the first character of the sentence (i.e. use `[d]isplay` instead of `[D]isplay`).
|
||||
|
@ -419,7 +419,7 @@ For example, `[d]ownload` in English may be translated into `[d]escargar` in Spa
|
|||
|
||||
- Optionally, mnemonics and their enclosed terms can be separated with brackets from the rest of the description (i.e. `([a]ll)`) in translations and specific pages to provide additional context or mention a word not present in the description.
|
||||
|
||||
> [!NOTE]
|
||||
> [!NOTE]\
|
||||
> In cases where the character isn't present in the translated word, you can highlight the option before/next to the equivalent word or you can add the English work beside the translation inside a bracket.
|
||||
> For example, `E[x]tract` in English maybe translated into `[x] ekstrak` or `ekstrak [x]` or `ekstrak (E[x]tract)` in Indonesian.
|
||||
|
||||
|
@ -467,7 +467,7 @@ Keep the following guidelines in mind when choosing placeholders:
|
|||
- In case of a possible reference both to a file or a directory,
|
||||
use `{{path/to/file_or_directory}}`.
|
||||
|
||||
> [!NOTE]
|
||||
> [!NOTE]\
|
||||
> If the command is specific to Windows, use backslashes (`\`) instead, such as `{{path\to\file_or_directory}}`. Drive letters such as `C:` are optional unless the command input requires an absolute path
|
||||
> or specific drive letter range, such as `cd /d {{C}}:{{path\to\directory}}`.
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue