1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-23 14:02:08 +02:00
Commit graph

87 commits

Author SHA1 Message Date
Managor
0a5c098c4e
style-guide: do not translate example.com (#15744)
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
2025-02-19 17:23:18 +00:00
Managor
9e3ee84a3c
style-guide: minor grammar correction (#15715)
minor grammar correction
2025-02-11 12:47:52 +01:00
Managor
6a0b9dbf84
style-guide: clarify shortform option style (#15703) 2025-02-09 04:18:16 +01:00
cyqsimon
4b6600a3ab
style-guide: recommend hyphen over en dash and em dash (#15407)
Co-authored-by: Wiktor Perskawiec <git@spageektti.cc>
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2025-01-04 19:53:31 +01:00
Martin Blume
6613e0f525
14851: Do not use serial comma in negative example (#14852)
The example used to highlight the ambiguity when not using a serial comma was actually using the serial comma. Thus, making the example not helpful.
This commit removes this erroneous usage of the comma in the example.
2024-11-16 12:54:09 +01:00
Lena
1be22f6d8b
style-guide, pages/*: remove "More information" from alias pages (#14766) 2024-11-10 19:13:03 +01:00
Lena
379a6e4388
style-guide: readd guidelines for --opt arg (#14383)
#10906 again, this line was removed for some reason.
2024-10-26 06:23:18 +05:30
K.B.Dharun Krishna
5a7a210d69
feat: update clients wiki to new link (#13914)
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-10-01 15:13:28 +02:00
K.B.Dharun Krishna
35928f41d8
style-guide: update note on cases (#13256) 2024-07-11 20:49:10 +03:00
spageektti
5a1c363361
*: change command line to command-line (#12996)
Change `command line` to `command-line`
2024-06-16 22:46:42 +02:00
K.B.Dharun Krishna
a8ec294384
style-guide, pages/windows/*: add note for PowerShell descriptions (#12904)
*: add note for pwsh descriptions

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-06-07 12:04:32 +02:00
spageektti
50039dc9ce
style-guide: fix typos (#12902) 2024-06-06 18:13:00 +02:00
Erin Cohen
e9fa24996c
style-guide: fix typos (#12816)
Co-authored-by: spageektti <git@spageektti.cc>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-05-22 18:20:22 +02:00
Lena
702010d6ed
style-guide: update the "See also" section (#12756)
* style-guide: update the "See also" section

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-05-09 18:52:06 +05:30
Alejandro Cervera
dfc47a0cd6
contributing-guides: document preference of Spanish words in placeholders (#12693)
* contributing-guides: document preference of Spanish words in placeholders

---------

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>
2024-04-29 13:04:22 +05:30
Vítor Henrique
5e6dc70b2c
style-guide: organize content and update sections; *: fix Markdownlint errors (#12148)
* style-guide: organize content and add contents section

* style-guide: fix general writing section title

* style-guide: fix heading level of help and version commands

* style-guide: fix heading level of see also section

* cleanup: update files

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

* contributing: fix page for markdown lint

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

* fix: markdownlint errors across files

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

* docs: improve documentation about keycaps

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

* docs: add info about optional and string placeholders

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

* cleanup: sync changes with recent versions of style guide

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

* cleanup: update style guide

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

* docs: update style guide

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

* docs/style-guide: reword more info links section

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

---------

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-04-22 09:20:17 +05:30
Vitor Henrique
21ad18714b
cleanup/style guide: update descriptions section (#12313)
* cleanup/style guide: update descriptions section

* style-guide: merge branch #12304 into descriptions section

* style-guide: rename Descriptions/Style to Formatting

* style-guide: replace "brand project names" with "proper names"

Co-authored-by: Juri Dispan <juri.dispan@posteo.net>

* style-guide: apply suggestions from code review

Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>

---------

Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
2024-03-14 12:33:09 -03:00
K.B.Dharun Krishna
5da4cacd9c
style-guide: update page (#12304)
* style-guide: update page

---------

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
2024-02-23 16:33:59 +05:30
Vitor Henrique
c7868a7c9c
style-guide: recommend keith.github.io for osx pages (#12097)
* style-guide: recommend keith.github.io for osx pages

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-01-22 09:43:24 +05:30
Vitor Henrique
320d0e7f0e
style-guide: clarify available man pages on manned.org (#12096) 2024-01-21 12:48:40 +05:30
Reinhart Previano Koentjoro
6e6041644a
style-guide: use "berkas" instead of "file" in Indonesian translations (#12083) 2024-01-19 14:54:04 +05:30
Alejandro Cervera
69693b3c80
style-guide: document conjugation of descriptions in Spanish (#11995)
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-01-04 17:29:35 +01:00
Vitor Henrique
c752d19374
style-guide: add emphasis section (#11971)
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2024-01-03 15:19:45 +01:00
Vitor Henrique
a9f7c8fcba
style-guide: add documentation for "See also" links (#11868)
Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-31 13:57:47 +01:00
K.B.Dharun Krishna
161f26d045
cleanup: update style guide (#11860)
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2023-12-28 17:31:20 +01:00
Vitor Henrique
793d2a47c2
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>
2023-12-27 15:13:32 +05:30
Vitor Henrique
afb9b61f9c
style-guide: add Portuguese specific rules (#11770)
style-guide: add Portuguese-Specific Rules
2023-12-17 01:44:48 -03:00
Juri Dispan
f9606bbcc5
style-guide: modify grouping placeholders section (#11723) 2023-12-12 05:33:35 +01:00
K.B.Dharun Krishna
2793c40467 style-guide: fix list
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-04 21:26:19 +00:00
K.B.Dharun Krishna
b6b3520d72 style-guide: fix typo 2023-12-04 21:26:19 +00:00
K.B.Dharun Krishna
81b01c8c6b style-guide: update page
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-04 21:26:19 +00:00
Reinhart Previano Koentjoro
9933b7bdd8 style-guide: clarify mnemonic guidelines 2023-12-04 21:26:19 +00:00
Reinhart Previano Koentjoro
4a1f8a8012 Update contributing-guides/style-guide.md 2023-12-04 21:26:19 +00:00
Reinhart Previano Koentjoro
eab7e5cdcb Update contributing-guides/style-guide.md
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2023-12-04 21:26:19 +00:00
Reinhart Previano Koentjoro
4fec07719d style-guide: clarify PowerShell range validation 2023-12-04 21:26:19 +00:00
Reinhart Previano Koentjoro
e884d83b07 style-guide: add mnemonic translations 2023-12-04 21:26:19 +00:00
Reinhart Previano Koentjoro
67f90450a4 style-guide: add mnemonic translations 2023-12-04 21:26:19 +00:00
Reinhart Previano Koentjoro
8b8a2d2de0 style-guide: fix missing PowerShell alias types 2023-12-04 21:26:19 +00:00
Reinhart Previano Koentjoro
584688c0c9 style-guide: add short option mnenonics, and windows- and powershell-specific rules 2023-12-04 21:26:19 +00:00
Sebastiaan Speck
fdca74b9b4
style-guide: fix typo (#11516) 2023-11-16 00:28:40 +01:00
Magrid
54a5de5b6d
style-guide: add and update documentation about URLs (#11320)
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-30 10:19:41 +01:00
Reinhart Previano Koentjoro
aba00dfa4c
style-guide: add Indonesian-specific guidelines (#10987)
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-25 21:28:11 +02:00
Lena
9ced683c99
style-guide: add guidelines for standard streams; fix remaining pages (#11196)
* readonly, {un,}compress, zbarcam: use proper syntax for IO streams

* style-guide: add guidelines for standard streams

* duckdb, perl: add backticks around stdin and stdout
2023-10-24 06:55:09 +05:30
Lena
7856124245
docs: use the new [!NOTE] syntax (#10959)
* style-guide: use the new note syntax
* MAINTAINERS: use the new note syntax, use full month names
* CONTRIBUTING: use the new note syntax
* maintainers-guide: use the new note syntax
* CLIENT-SPECIFICATION: use the new note syntax
* COMMUNITY-ROLES: use the new note syntax
* git-terminal: use the new note syntax

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-13 01:26:58 +02:00
Lena
5afb6ec14e
style-guide: add guidelines for --opt arg, improve wording (#10906) 2023-10-11 09:57:23 +02:00
Lena
6e0a21c58b
krita: move to common, update description; style-guide: add description guidelines (#10858) 2023-10-09 19:12:47 +07:00
K.B.Dharun Krishna
2135714193
pages/*, style-guide: update contents, fix Markdown (#10492)
* pages/*, style-guide: update pages, fix Markdown (commit 1)

* Update pages

* style-guide.de: update page

* Apply suggestions from code review

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>

* pip3: remove search command

* rpm: update path placeholder

Co-authored-by: pixel <pixel+github@chrissx.de>

* Update pages/linux/pkgfile.md

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>

---------

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
Co-authored-by: pixel <pixel+github@chrissx.de>
2023-08-26 23:00:06 +05:30
Emily Grace Seville
6b405eb7e0
Remove rules for ranges and options (#9793)
* Remove rules for ranges and options

* Return "Option syntax"
2023-02-09 07:47:56 +05:30
Emily Grace Seville
5fd383d53f
Use n instead of infinity (#9759) 2023-01-11 23:49:41 +10:00
Emily Grace Seville
0284c2390a
style-guide: refresh page: move ellipsis to a separate section and extend syntax (#9742)
* Move and reword ellipsis to a separate section

* Add notes about grouping placeholders

* Permit specifing repetition count for placeholders

* Mandate using simplified range syntax for ellipsis

* Update contributing-guides/style-guide.md

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* Remove redundant note

* Refresh repetition syntax for ellipsis

* Don't allow restrict repetition count via ellipsis

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-01-10 09:54:53 +08:00