Spec compliance (--platform)

[pixelcmtd]

We recently had some internal misconceptions (tldr-pages/tldr#6869) because of clients, especially this one, not complying to the spec by using -o/--os instead of -p/--platform. Is that only because of --pager and are you planning to fix it?

Things to change in order to conform to the client specification:

• Rename -o/--os to -p/--platform → Rename -o / --os to -p / --platform #217
• When doing a page lookup, ensure that the page name must be lowercased (tldr AbC should display the page called abc`) → Lowercase page names before lookup #227
• Support the platform all which works like the default platform, but lists pages from all platforms when calling --list → Support platform type "all" #229

[niklasmohrin]

It's a known mistake, see #120 and #106 (comment). We wanted to make the move to another argument parsing lib once its new major release comes out (and fix some flags while we are at it), but it is taking a lot longer than anticipated. I think we could still fix this in the next release, we already have breaking changes for one flag. @dbrgn ?

[CleanMachine1]

👍 for fitting spec, makes documentation easier and everyone being able to use the same provided information.

[dbrgn]

Things to change in order to conform to the client specification:

• Rename -o --os to -p --platform
• When doing a page lookup, ensure that the page name must be lowercased (e.g. tldr eyeD3 should return the page called eyed3)
• Low prio: Support the platform all which works like the default platform, but lists pages from all platforms when calling --list

[niklasmohrin]

Should we convert your list to issues with a custom label / milestone?

[dbrgn]

Sure, why not 🙂

Edit: I decided to send PRs instead of opening issues 😄

[dbrgn]

I decided to drop the issue with the platform type "all" from the spec compliance list, since its place in the spec is disputed (see tldr-pages/tldr#7528 and tldr-pages/tldr#7561). We'll keep tracking those issues, but the compliance work for the client specification v1.5 is done here, I think.