Skip to content

Commit

Permalink
CLIENT-SPECIFICATION: add lowercasing of commands (#5327)
Browse files Browse the repository at this point in the history
  • Loading branch information
MasterOdin committed Mar 11, 2021
1 parent 3c118dd commit 8505e55
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions CLIENT-SPECIFICATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,28 +59,19 @@ tldr -l

The first argument that does not start with a dash (`-`), MUST be considered the page name.

In addition, page names MAY contain spaces (e.g. `git status`) - such page names MUST be transparently concatenated with dashes (`-`). For example, the page name:
Page names MAY contain spaces (e.g. `git status`), and such page names MUST be transparently concatenated with dashes (`-`). For example, the page name `git checkout` becomes `git-checkout`.

```
git checkout
```

becomes this:

```
git-checkout
```
Page names MAY contain mixed capitalization, and such page names MUST be transparently lowercased. For example, the page name `eyeD3` becomes `eyed3`.

Here are some example invocations:

```bash
tldr 7za
tldr eyeD3
tldr git checkout
tldr eyeD3 # equivalent to tldr eyed3
tldr git checkout # equivalent to tldr git-checkout
tldr --platform osx bash
```


## Directory structure

This section documents the directory structure that contains the pages themselves.
Expand Down Expand Up @@ -130,7 +121,7 @@ Although this specification is about the interface that clients must provide, it

This section defines the algorithm by which a client can decide which page a user has requested.

After transparently replacing spaces (` `) with dashes (`-`), clients have several decisions to make:
After transparently replacing spaces (` `) with dashes (`-`) and lowercasing the name, clients have several decisions to make:

- The language of a page to display to a client
- The platform to display a page from
Expand Down

0 comments on commit 8505e55

Please sign in to comment.