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

[Bug] Help text for CLI commands is not properly formatted #745

Closed
3 tasks done
bartvanb opened this issue Jul 4, 2023 · 0 comments
Closed
3 tasks done

[Bug] Help text for CLI commands is not properly formatted #745

bartvanb opened this issue Jul 4, 2023 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@bartvanb
Copy link
Member

bartvanb commented Jul 4, 2023

Describe the bug
The help text for CLI commands is weirdly formatted.

Example: vnode attach --help gives:

Usage: vnode attach [OPTIONS]

  Attach the logs from the docker container to the terminal.

  Parameters ---------- name : str     Name of the configuration file.
  system_folders : bool     Wether this configuration stored in the system or
  in the user folders.

Options:
  -n, --name TEXT  configuration name
  --system
  --user
  --help           Show this message and exit.
  • Wait for added files to create demo collaboration #624 to start this to prevent merge conflicts
  • Remove the Parameters section, instead add help to the relevant options
  • Check the docs to see if this is properly displayed (does not seem to be the case in live version!)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
Development

No branches or pull requests

2 participants