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 tldr shows invalid command examples #76

Closed
JCGoran opened this issue Mar 17, 2019 · 2 comments
Closed

tldr tldr shows invalid command examples #76

JCGoran opened this issue Mar 17, 2019 · 2 comments

Comments

@JCGoran
Copy link
Contributor

JCGoran commented Mar 17, 2019

Running tldr tldr shows an invalid tldr command:

user@host:~$ ./tldr.py tldr  
# tldr                                                                                                                                                
                                                                     
  Simplified man pages.                                                  
                                                                     
- Get typical usages of a command (hint: this is how you got here!): 
                                                                            
  tldr command                                          
                                                               
- Show the tar tldr page for linux:                      
                                                                      
  tldr -p linux tar                                                  
                                                                   
- Get help for a git subcommand:                                              
                                                                             
  tldr git checkout

Then if the user tries the second example:

tldr -p linux tar

he is greeted with the following:

user@host:~$./tldr.py -p linux tar
usage: tldr.py [-h] [-u] [-o {linux,osx,sunos}] [-s SOURCE] [-c]
               command [command ...]
tldr.py: error: unrecognized arguments: -p

Tested both the python-pip, python3-pip versions on a Debian machine, and by directly cloning the repo, with identical results.

@waldyrious
Copy link
Member

That's an issue with the tldr page for tldr, which assumes functionality implemented for some clients (notably the node.js one) to be common functionality available in all clients.

The recent work on a spec for clients will probably help here. /cc @sbrl.

@sbrl
Copy link
Member

sbrl commented Mar 17, 2019

Hey, thanks for reporting this @JCGoran! Indeed, we've (very) recently developed an official client specification. To this end, not all clients have been updated yet to support it - in particular the multi-language support is not implemented by many clients yet.

Would you like to send a PR for support here on the python client?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants