ManimCommunity / manim

A community-maintained Python framework for creating mathematical animations.
https://www.manim.community
MIT License
19.95k stars 1.48k forks source link

Command line help text is cut off #1911

Closed Darylgolden closed 2 years ago

Darylgolden commented 2 years ago

Enhancement proposal

When running manim --help, the following output is returned:

Manim Community v0.9.0

Usage: manim [OPTIONS] COMMAND [ARGS]...

  Animation engine for explanatory math videos

Options:
  --version  Show version and exit.
  --help     Show this message and exit.

Commands:
  render*  Render SCENE(S) from the input FILE.
  cfg      Manages Manim configuration files.
  init     Sets up a project in current working directory with default...
  new      Create a new project or insert a new scene.
  plugins  Manages Manim plugins.

  Made with <3 by Manim Community developers.

As you can see, the help text for init is cut off, and does not provide sufficient information about what that command does.

Additional comments

k4pran commented 2 years ago

I can update it to show the full text, but it seems like a lot or do you think it looks okay? The last line seems to say the same as the first so think it can at least be removed?

Manim Community v0.8.0

Usage: __main__.py [OPTIONS] COMMAND [ARGS]...

  Animation engine for explanatory math videos

Options:
  --version  Show version and exit.
  --help     Show this message and exit.

Commands:
  render*  Render SCENE(S) from the input FILE.
  cfg      Manages Manim configuration files.
  init     Sets up a project in current working directory with default
           settings.

           It copies files from templates directory and pastes them in the
           current working dir.

           The new project is set up with default settings.

  new      Create a new project or insert a new scene.
  plugins  Manages Manim plugins.

  Made with <3 by Manim Community developers.