From fbdc06b7425f92cc0d4fc9a5cfc5860ef017251e Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Sun, 31 Mar 2019 23:09:42 +0100 Subject: [PATCH] clieent spec: Add messaage to page resolution section --- CLIENT-SPECIFICATION.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 7f60368fdc..66764c8c36 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -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: