Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tldr: add --update example #744

Merged
merged 1 commit into from
Feb 6, 2016
Merged

Conversation

oxguy3
Copy link
Contributor

@oxguy3 oxguy3 commented Jan 28, 2016

The --update flag in the tldr command is super useful, and I was really surprised it wasn't in the tldr page when I was trying to remember how to update the other day. Thus, I've added it here!

@igorshubovych
Copy link
Collaborator

Well, it turned to be there are tons of tldr CLI clients

And not all of them have this flag :(

cc @waldyrious, @rubenvereecken

@oxguy3
Copy link
Contributor Author

oxguy3 commented Jan 28, 2016

Mannn, why'd they all have to call themselves tldr? 😛

@rubenvereecken
Copy link
Contributor

This is rather too bad but we never standardized clients, only this repository and how to interpret its contents. I don't even know which ones can be considered official and I've never used anything else except the Node.js client (official if any is).

I wouldn't add it.

@oxguy3
Copy link
Contributor Author

oxguy3 commented Jan 28, 2016

I think the NodeJS one could be considered "official", as that's the one that tldr-pages' website tells you to install: https://tldr-pages.github.io/.

@rubenvereecken
Copy link
Contributor

The reason I'm not deciding here is because I abstained from the whole discussion on clients and which to consider official. I'd love to just consider that one official and have that flag in otherwise.

@waldyrious
Copy link
Member

This is clearly another reason for us to decide on a standard set of features we'd expect tldr (command line) clients to provide. @igorshubovych already started a page at https://github.com/tldr-pages/tldr/wiki/Minimum-specifications-for-TLDR-command-line-clients, but it needs some love. Shall we open an issue to track that discussion?

@leostera
Copy link
Contributor

leostera commented Feb 3, 2016

This actually is a good way of enforcing a spec for a client, not only because it outlines the features we require, but also because it's in itself a tldr page.

@waldyrious
Copy link
Member

Great point, @Ostera -- the tldr page for tldr should indeed work as the minimum spec for tldr clients! So looking at it from this point of view, what other options would we want to be universal to all clients? I agree with --update. I suppose at least --help should be present too.

@igorshubovych
Copy link
Collaborator

@Ostera @waldyrious agree with you about --update, it seems it makes sense.

However, --help becomes standard de-facto. Majority of commands have it, so I do not think it makes sense to list it separately. Additionally, NodeJS client has the same output for $ tldr --help and for just $ tldr.

@waldyrious
Copy link
Member

Well, if we start reaching the maximum limit of examples (#686), we can remove --help, but for now it would be a good way to enforce it for all clients. It seems to fit better here (and in a more explicit way) than in the wiki page, which currently says "it should list supported features".

The fact that just tldr does the same is either a bonus for the node client, or something we would want for all clients (and thus we should add here too).

@igorshubovych
Copy link
Collaborator

Thank you!

igorshubovych added a commit that referenced this pull request Feb 6, 2016
tldr: added `--update` example
@igorshubovych igorshubovych merged commit 8432dc5 into tldr-pages:master Feb 6, 2016
@waldyrious waldyrious added new command Issues requesting creation of a new page. clients Issues pertaining to a particular client or the clients as whole. labels Feb 7, 2016
@oxguy3 oxguy3 deleted the tldr-tldr branch February 8, 2016 14:21
@waldyrious waldyrious changed the title tldr: added --update example tldr: add --update example Aug 31, 2016
@waldyrious waldyrious added page edit Changes to an existing page(s). and removed new command Issues requesting creation of a new page. labels Aug 31, 2016
@waldyrious waldyrious added the decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. label Sep 16, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clients Issues pertaining to a particular client or the clients as whole. decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants