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

Truncated command help text for dagshub repo --help #310

Open
guysmoilov opened this issue Jun 11, 2023 · 3 comments
Open

Truncated command help text for dagshub repo --help #310

guysmoilov opened this issue Jun 11, 2023 · 3 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@guysmoilov
Copy link
Member

Tried running dagshub repo --help and this is the full help text that gets printed:

Usage: dagshub repo [OPTIONS] COMMAND [ARGS]...

  Operations on repo: currently only 'create'

Options:
  --help  Show this message and exit.

Commands:
  create  create a repo and:
@guysmoilov guysmoilov added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 11, 2023
@gokullan
Copy link

gokullan commented Jun 14, 2023

Hi, there. This seems to be an issue with click itself (See here). However if we make the fix specified in the link, it could be corrected. I think I should be able to do this. Can this be assigned to me?

@guysmoilov
Copy link
Member Author

@gokullan Sure, thank you, go ahead!

@gokullan
Copy link

gokullan commented Jun 14, 2023

I've worked on it and one solution is to use short_help instead of help. This is what I obtained:

Usage: dagshub repo [OPTIONS] COMMAND [ARGS]...

  Operations on repo: currently only 'create'

Options:
  --help  Show this message and exit.

Commands:
  create  create a repo and:
          
          optional- upload files to 'data' dir, .zip and .tar files are
          extracted, other formats copied as is.
          
          optional- clone repo locally.
          
          example 1:  dagshub repo create mytutorial -u
          "http://example.com/data.csv" --clone
          
          example 2:  dagshub --host "https://www.dagshub.com" repo create
          mytutorial2 -u "http://0.0.0.0:8080/index.html" --clone --verbose

I tried other ways to manipulate the string (to eliminate some of the newlines), but this was the best I could do. Is this okay?

This issue pops up because create is a sub-command (of repo). And click doesn't handle these sub-commands the way we expect it to ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants