Tldr: harmonize "command line" mentions

Created on 26 May 2020  路  4Comments  路  Source: tldr-pages/tldr

Hi
I was browsing around our pages and I've noticed that in multiple pages (especially on the descriptions) we state that the described command is a "command-line tool", "CLI Utility", "CLI", etc.

There seems to be no pattern in that.
Should we think of a standardized way to state that?
Or should we state that at all? Being documented here doesn't already mean that it is a command-line tool?

I'll wait for your comments on that for me to do something about this.

Most helpful comment

TBH, I wouldn't change that at all. Such descriptions usually originate from the command's docs, as it was the case in #4066. I think it's safer and easier to assume the official docs are correct, rather than to try to manually standardize them.

All 4 comments

TBH, I wouldn't change that at all. Such descriptions usually originate from the command's docs, as it was the case in #4066. I think it's safer and easier to assume the official docs are correct, rather than to try to manually standardize them.

I will stay neutral. I think this may be the interesting of a language. We can describe one thing with a lot of ways and both pattern can be understand. Here I think "command-line tool" or "CLI Utility" or "CLI" can be understand through the context.

I agree with @zdroid here. It's probably best to stick with the terminology that the program uses in its official documentation, as that's what users will usually be most familiar with.

That seems to be the general consensus then. I will give this some more hours if anyone wants to add anything on this discussion.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

GabLeRoux picture GabLeRoux  路  3Comments

hrai picture hrai  路  3Comments

zlatanvasovic picture zlatanvasovic  路  3Comments

schneiderl picture schneiderl  路  3Comments

TobiasRoland picture TobiasRoland  路  3Comments