Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

update misleading -h flag in document (#1819)

Vinh H. Pham (Vincent)ce7d67b1094e
diff --git a/docs/source/changelog/0.6.0-changelog.rst b/docs/source/changelog/0.6.0-changelog.rst
index 4c3d85cc6..4a60a8e0e 100644
--- a/docs/source/changelog/0.6.0-changelog.rst
+++ b/docs/source/changelog/0.6.0-changelog.rst
@@ -97,7 +97,7 @@ Breaking changes
In Argparse: ``manim basic.py -p -ql``
With Click: ``manim -p -ql basic.py``
- Although this is primarily a refactor and most of the common options are still there, some options have been added/removed. Use the ``manim`` command's ``-h``, ``--help`` option, or simply run the command without providing options/arguments to view the help page with the full list of subcommands/options/arguments.
+ Although this is primarily a refactor and most of the common options are still there, some options have been added/removed. Use the ``manim`` command's ``--help`` option, or simply run the command without providing options/arguments to view the help page with the full list of subcommands/options/arguments.
- Added a ``--fps``/``--frame_rate`` option which allows for custom fps that don't have to be integer (i.e. 29.97, 23.98, etc.). Users no longer have to specify the FPS from within a config file. Additionally, the ``--webgl_renderer_fps`` option has been removed. Use ``--fps`` or ``--frame_rate`` instead.
- Added a ``--renderer`` option which you can use to select your choice of renderer (e.g. ``--renderer=opengl``). There are currently *THREE* renderers to choose from!
diff --git a/docs/source/tutorials/configuration.rst b/docs/source/tutorials/configuration.rst
index 11fadd86b..efc5e5e3c 100644
--- a/docs/source/tutorials/configuration.rst
+++ b/docs/source/tutorials/configuration.rst
@@ -361,7 +361,7 @@ A list of all CLI flags
.. code::
- manim -h
+ manim --help
Usage: manim [OPTIONS] COMMAND [ARGS]...
@@ -369,7 +369,7 @@ A list of all CLI flags
Options:
--version Show the version and exit.
- -h, --help Show this message and exit.
+ --help Show this message and exit.
Commands:
render* Render SCENE(S) from the input FILE.
@@ -382,6 +382,6 @@ Each of the subcommands has its own help page which can be
.. code::
- manim render -h
- manim cfg -h
- manim plugins -h
+ manim render --help
+ manim cfg --help
+ manim plugins --help