opensource/tldr
3
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2026-10-30 18:53:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

style-guide: update file extension usage (#20175)

Browse Source 
Co-authored-by: Ivan Baluta <ivanbaluta.dev@gmail.com>
This commit is contained in:
Meinard Francisco
2025-12-23 06:23:51 +02:00
committed by GitHub
co-authored by Ivan Baluta
parent 30d214f564
commit 9d273b3a20
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
contributing-guides/style-guide.md
+4 -4
View File
@@ -534,11 +534,11 @@ Keep the following guidelines in mind when choosing placeholders:
#### Extensions
- If a particular extension is expected for the file, append it.
For example, `unrar x {{path/to/compressed.rar}}`.
- If the extension represents the most common format but the command accepts related variations (such as multi-volume `.r00` or `.part1.rar` archives), keep it **inside** the placeholder: `unrar x {{path/to/archive.rar}}`.
- If the command strictly requires one specific extension and no others to function, keep the extension **outside** the placeholder to indicate it is mandatory: `java -jar {{path/to/filename}}.jar`.
- In case a generic extension is needed, use `{{.ext}}`, but **only** if an extension is required.
For instance, in `find.md`'s example "Find files by extension" (`find {{path/to/root}} -name '{{*.ext}}'`)
using `{{*.ext}}` explains the command without being unnecessarily specific;
while in `wc -l {{path/to/file}}` using `{{path/to/file}}` (without extension) is sufficient.
- For instance, in `find.md`'s example "Find files by extension" (`find {{path/to/root}} -name '{{*.ext}}'`), using `{{*.ext}}` explains the command without being unnecessarily specific.
- In `wc -l {{path/to/file}}`, using `{{path/to/file}}` (without an extension) is sufficient.
#### Grouping placeholders