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

CLIENT-SPECIFICATION: rephrase requirement to implement option variants (#15772)

Browse source 
Rephrase requirement to implement option variants

The new phrasing does not imply that all options have a short and long
form specified in the table.
This commit is contained in:
Niklas Mohrin 2025-02-24 03:23:29 +01:00 • committed by GitHub
parent f3663d668d
commit 906b1fbf1f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CLIENT-SPECIFICATION.md
View file

@ -30,7 +30,11 @@ This section describes the standardised command-line interface (CLI) for clients
### Arguments
The following table documents what command-line options MUST be supported and which are optional. If an option is implemented both the short and long versions MUST be available:
The following table documents what command-line options MUST be supported and which are optional.
When adding support for an option, clients MUST implement all variants of that option listed in the table.
For example, clients should implement _both_ `-v` and `--version`.
When a client implements updating the offline cache, they should support _both_ `-u` and `--update`.
Option | Required? | Meaning
-----------------------|-------------|----------