DawnMagnet/tldr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clieent spec: Add messaage to page resolution section

Browse Source
This commit is contained in:
Starbeamrainbowlabs
2019-03-31 23:09:42 +01:00
parent cf40e4d1b4
commit fbdc06b742
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CLIENT-SPECIFICATION.md
View File

@@ -146,6 +146,8 @@ For example, a user has a client on windows, and requests the `apt` page. The cl
Steps #3 and #4 may be done in either order.
It is possible that due to this page resolution logic, the client may show a page which does not belong to the host platform because a page can reside in `common`, and not be present on the host platform. Clients must not assume that a given command is always executable on the host platform.
#### If a page isn't found
If a page cannot be found in _any_ platform, then it is RECOMMENDED that clients display an error message with a link to create a new issue against the `tldr-pages/tldr` GitHub repository. Said link might take the following form: