search

tealdeer-rs / tealdeer

A very fast implementation of tldr in Rust.
https://tealdeer-rs.github.io/tealdeer/
Apache License 2.0
4.17k stars 123 forks source link

Add "macos" alias for "osx" #215

Closed dbrgn closed 2 years ago

dbrgn commented 2 years ago

The Apple computer operating system was renamed from "OS X" to "macOS" in 2016. We should accept "macos" in addition to "osx" in all our CLI APIs, and the docs should also mention this alias instead of "osx".

For backwards compatibility and for compatibility with the tldr client specification, we should still accept "osx" though.

niklasmohrin commented 2 years ago

Will you run this by tldr-pages/tldr or should I?

dbrgn commented 2 years ago

Would be great if you could do that!

dbrgn commented 2 years ago

@niklasmohrin should we wait with this until there's progress in https://github.com/tldr-pages/tldr/issues/7076?

niklasmohrin commented 2 years ago

I am not really expecting any new input from the upstream issue unless we actively engage again (and that is totally fair). I guess we could ask tldr maintainers if they want to conclude anything from the current comments and make a decision. Should we?

dbrgn commented 2 years ago

@niklasmohrin I pinged them in the chat. I think we can still add the alias in the next version, it doesn't hurt and it's highly unlikely that a spec change will be conflicting.

I'll rebase this PR, so we could merge it for the 1.5 release if we decide to do so.

dbrgn commented 2 years ago

Rebased. I also found an option to hide the "possible values" for the -o parameter.

I think we should merge this for the 1.5 release.

niklasmohrin commented 2 years ago

Rebased. I also found an option to hide the "possible values" for the -o parameter.

Nice. We could also hide the option altogether, don't know if we should though

I think we should merge this for the 1.5 release.

:+1: