From 4628be7b6d53939f92a77e8acb2c2ab5f225a75c Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Wed, 23 Jan 2019 14:14:37 +0000 Subject: [PATCH] client spec: Tidy up optional platform specifier. --- CLIENT_SPECIFICATION.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/CLIENT_SPECIFICATION.md b/CLIENT_SPECIFICATION.md index b752bce061..253f06457c 100644 --- a/CLIENT_SPECIFICATION.md +++ b/CLIENT_SPECIFICATION.md @@ -78,7 +78,7 @@ tldr git checkout tldr --foo bar bash ``` -Furthermore, clients may OPTIONALLY support a colon to specify the platform name in addition to the `--platform`, `-p` syntax described above Here are some examples: +Furthermore, clients may OPTIONALLY support a colon to specify the platform name Here are some examples: ```bash tldr platform:page @@ -87,21 +87,23 @@ tldr common:git checkout ``` #### Specifying the Platform -As pages are grouped by platform, a user may want to access a platform-specific version of a page. This MUST be supported by prefixing the page name as follows: +As pages are grouped by platform, a user may want to access a platform-specific version of a page. This MAY OPTIONALLY be supported by prefixing the page name as follows, in addition to the `--platform`, `-p` syntax described above: ``` -windows/type -linux/sh -osx/brew +platform:page +windows:type +linux:sh +osx:brew +common:git checkout ``` Example invocations are as follows: ```bash -tldr windows/type +tldr windows:type # --foo is a custom argument, as described above -tldr --foo bar common/git merge -tldr linux/notify-send +tldr --foo bar common:git merge +tldr linux:notify-send ```