lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-07-03 16:35:23 +02:00
Code Activity

style-guide: refresh page (#8858)

Browse source
This commit is contained in:
K.B.Dharun Krishna 2022-10-16 05:08:39 +05:30 • committed by GitHub
parent 152686c0d5
commit cae5ae7058
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
contributing-guides/style-guide.md
View file

@ -33,23 +33,23 @@ Example:
> See also: `gimp`. > See also: `gimp`.
> More information: <https://docs.krita.org/en/reference_manual/linux_command_line.html>. > More information: <https://docs.krita.org/en/reference_manual/linux_command_line.html>.
- Start krita: - Start Krita:
`krita` `krita`
- Start without a splash screen:
`krita --nosplash`
- Open specific files: - Open specific files:
`krita {{path/to/image1 path/to/image2 ...}}` `krita {{path/to/image1 path/to/image2 ...}}`
- Start with a specific workspace (`Animation`): - Start without a splash screen:
`krita --nosplash`
- Start with a specific workspace:
`krita --workspace {{Animation}}` `krita --workspace {{Animation}}`
- Start in a fullscreen mode: - Start in fullscreen mode:
`krita --fullscreen` `krita --fullscreen`
``` ```
@ -130,7 +130,7 @@ Keep the following guidelines in mind when choosing tokens:
- In case of a possible reference both to a file or a directory, - In case of a possible reference both to a file or a directory,
use `{{path/to/file_or_directory}}`. use `{{path/to/file_or_directory}}`.
Extensions ### Extensions
- If a particular extension is expected for the file, append it. - If a particular extension is expected for the file, append it.
For example, `unrar x {{compressed.rar}}`. For example, `unrar x {{compressed.rar}}`.
@ -141,12 +141,12 @@ Extensions
### Special cases ### Special cases
- If a command performs irreversible changes to a file system or devices, - If a command performs irreversible changes to a file system or devices,
write every example in a way that they cannot be thoughtlessly copy-pasted. write every example in a way that cannot be thoughtlessly copy-pasted.
For example, instead of `ddrescue --force --no-scrape /dev/sda /dev/sdb` For example, instead of `ddrescue --force --no-scrape /dev/sda /dev/sdb`
write `ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}}` write `ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}}`
and use the `{{/dev/sdXY}}` placeholder for *block devices* instead of `/dev/sda1`. and use the `{{/dev/sdXY}}` placeholder for *block devices* instead of `/dev/sda1`.
- If a command can take a variable number of arguments, use an ellipsis: `{{arg1 arg2 ...}}` - If a command can take a variable number of arguments, use an ellipsis: `{{arg1 arg2 ...}}`.
If one of multiple options is possible, write it as `{{either|or}}`. If one of the multiple options is possible, write it as `{{either|or}}`.
In general, tokens should make it as intuitive as possible In general, tokens should make it as intuitive as possible
to figure out how to use the command and fill it in with values. to figure out how to use the command and fill it in with values.
@ -210,7 +210,7 @@ The following guidelines are applied to Chinese (zh) and traditional Chinese (zh
6. Use precise form for technical terms, and do not use unofficial Chinese abbreviations. 6. Use precise form for technical terms, and do not use unofficial Chinese abbreviations.
For example, use `Facebook` rather than `facebook`, `fb` or `脸书`. For example, use `Facebook` rather than `facebook`, `fb` or `脸书`.
In order to maintain readability and normalization, please comply the 6 rules above as much as possible when translating pages into Chinese. In order to maintain readability and normalization, please comply with the 6 rules above as much as possible when translating pages into Chinese.
For more information and examples of Chinese-specific rules, check out [*Chinese Copywriting Guidelines*](https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.en.md). For more information and examples of Chinese-specific rules, check out [*Chinese Copywriting Guidelines*](https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.en.md).