Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CLIENT-SPECIFICATION: add lowercasing of commands #5327

Merged
merged 5 commits into from
Mar 11, 2021
Merged

CLIENT-SPECIFICATION: add lowercasing of commands #5327

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3dd280e
Add lowercasing of command name to client specification
MasterOdin Mar 1, 2021
8262eaf
Update CLIENT-SPECIFICATION.md
MasterOdin Mar 1, 2021
bfad208
Update CLIENT-SPECIFICATION.md
MasterOdin Mar 9, 2021
8195fb2
Update CLIENT-SPECIFICATION.md
MasterOdin Mar 11, 2021
b2e425a
Update CLIENT-SPECIFICATION.md
MasterOdin Mar 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 5 additions & 14 deletions CLIENT-SPECIFICATION.md
View file
Open in desktop
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