lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-22 00:42:08 +02:00
Code Activity

rg, style-guide: improve heading wording (#15949)

Browse source
This commit is contained in:
Managor 2025-03-17 12:21:54 +02:00 • committed by GitHub
parent 6a6fa655ff
commit 987a7065e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -319,7 +319,7 @@ When describing keycaps or a keyboard shortcut for a utility, use the same [keyp
- Avoid using the page title in the description (e.g. use `A sketching and painting program designed for digital artists` instead of `Krita is a sketching and painting program designed for digital artists`)
- If the program name differs from its executable name, it can be named at the start of the heading (e.g. `rg` and Ripgrep).
- Avoid mentioning that the program is used on the command-line (e.g. use `Ripgrep is a recursive line-oriented search tool` instead of `Ripgrep is a recursive line-oriented CLI search tool`).
- Avoid mentioning that the program is used on the command-line (e.g. use `Ripgrep, a recursive line-oriented search tool` instead of `Ripgrep, a recursive line-oriented CLI search tool`).
For example, when writing documentation for `cd`, a tool to check out and work on a specific directory in the Terminal or Command Prompt, **do not** write a lengthy description such as:

2
pages/common/rg.md
View file

@ -1,6 +1,6 @@
# rg
> Ripgrep is a recursive line-oriented search tool.
> Ripgrep, a recursive line-oriented search tool.
> Aims to be a faster alternative to `grep`.
> More information: <https://github.com/BurntSushi/ripgrep>.