From b83f49c8744f1f624108c8a04d389a23eedfa900 Mon Sep 17 00:00:00 2001 From: pixel Date: Wed, 21 Dec 2022 06:12:16 +0100 Subject: [PATCH 1/3] CLIENT-SPECIFICATION: Require long options --- CLIENT-SPECIFICATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 83d8059e3b8b7f..25b03ed40a4644 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -41,7 +41,7 @@ Option | Required? | Meaning `-l`, `--list` | No | Lists all the pages in the current platform to the standard output. `-L`, `--language` | No | Specifies the preferred language for the page returned. Overrides other language detection mechanisms. See the [language section](#language) for more information. -Clients MAY choose to only implement the short version of an option, ignoring the long form. +Clients MUST implement both the short and long version of an option. Additional decoration MAY be printed if the standard output is a [TTY](http://www.linusakesson.net/programming/tty/index.php). If not, then the output MUST not contain any additional decorations. For example a page list MUST be formatted with 1 page name per line (to enable easy manipulation using standard CLI tools such as `grep` etc.). From a685690c0072376e92cff9ac62f216f80e41f790 Mon Sep 17 00:00:00 2001 From: pixel Date: Tue, 27 Dec 2022 13:52:24 +0100 Subject: [PATCH 2/3] Update CLIENT-SPECIFICATION.md --- CLIENT-SPECIFICATION.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 25b03ed40a4644..926ec664bea8f7 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -227,8 +227,9 @@ the commit hash changes when merging with squash or rebase. --> - Unreleased - - Add recommendation to support `macos` alias for `osx` ([#7514](https://github.com/tldr-pages/tldr/pull/7514)) - - Drop the special "all" platform from `--list` flag ([#7561](https://github.com/tldr-pages/tldr/pull/7561)) + - Add recommendation to support `macos` alias for `osx` ([#7514](https://github.com/tldr-pages/tldr/pull/7514)) + - Drop the special "all" platform from `--list` flag ([#7561](https://github.com/tldr-pages/tldr/pull/7561)) + - Require long options ([#9651](https://github.com/tldr-pages/tldr/pull/9651)) - [v1.5, March 17th 2021](https://github.com/tldr-pages/tldr/blob/v1.5/CLIENT-SPECIFICATION.md) ([#5428](https://github.com/tldr-pages/tldr/pull/5428)) - Add requirement for converting command names to lowercase before running the page resolution algorithm. From b1e3528d964e909596e580adfa6ca42b73b38907 Mon Sep 17 00:00:00 2001 From: pixel Date: Thu, 29 Dec 2022 15:30:36 +0100 Subject: [PATCH 3/3] Update CLIENT-SPECIFICATION.md Co-authored-by: Waldir Pimenta --- CLIENT-SPECIFICATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 926ec664bea8f7..1818d49478f64d 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -229,7 +229,7 @@ the commit hash changes when merging with squash or rebase. - Unreleased - Add recommendation to support `macos` alias for `osx` ([#7514](https://github.com/tldr-pages/tldr/pull/7514)) - Drop the special "all" platform from `--list` flag ([#7561](https://github.com/tldr-pages/tldr/pull/7561)) - - Require long options ([#9651](https://github.com/tldr-pages/tldr/pull/9651)) + - Require support for long options ([#9651](https://github.com/tldr-pages/tldr/pull/9651)) - [v1.5, March 17th 2021](https://github.com/tldr-pages/tldr/blob/v1.5/CLIENT-SPECIFICATION.md) ([#5428](https://github.com/tldr-pages/tldr/pull/5428)) - Add requirement for converting command names to lowercase before running the page resolution algorithm.