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

CLIENT-SPECIFICATION: clarify highlighting (#15801)

Browse source 
Update CLIENT-SPECIFICATION.md
This commit is contained in:
Managor 2025-03-02 07:07:30 +02:00 • committed by GitHub
parent 36e24a9348
commit ffaaa5085a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CLIENT-SPECIFICATION.md
View file

@ -126,6 +126,7 @@ Although this specification is about the interface that clients must provide, it
Things to take into account:
- Clients MAY highlight the placeholders and MUST remove the surrounding curly braces.
- If option placeholders are set to show only shortform or longform options, they MUST not be highlighted. This is because there is no longer user choice involved.
- Clients MUST remove the angle brackets from option placeholders when only short- or longform is shown.
- Clients MUST NOT treat them as the placeholder syntax if they are escaped using `\` (i.e. `\{\{` and `\}\}`) and MUST instead display literal braces, without backslashes. Placeholder escaping applies only when both braces are escaped (e.g. in `\{` or `\{{`, backslashes MUST be displayed).
- In cases when a command uses `{}` in its arguments (e.g. `stash@{0}`) **_the outer braces_** mark the placeholder - the braces inside MUST be displayed.