public-mirrors/3b1b-manim
1
0
Fork 0
mirror of https://github.com/3b1b/manim.git synced 2025-08-05 16:49:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

style/docs: fix argument help style and update docs for it

Browse source
This commit is contained in:
TonyCrane 2022-02-14 19:50:30 +08:00
parent fc1e916f42
commit f29ef87bba
No known key found for this signature in database
GPG key ID: 2313A5058A9C637C
2 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/source/getting_started/configuration.rst
View file

@ -43,6 +43,7 @@ flag abbr function
``--hd`` Render at a 1080p quality ``--hd`` Render at a 1080p quality
``--uhd`` Render at a 4k quality ``--uhd`` Render at a 4k quality
``--full_screen`` ``-f`` Show window in full screen ``--full_screen`` ``-f`` Show window in full screen
``--presenter_mode`` ``-p`` Scene will stay paused during wait calls until space bar or right arrow is hit, like a slide show
``--save_pngs`` ``-g`` Save each frame as a png ``--save_pngs`` ``-g`` Save each frame as a png
``--save_as_gif`` ``-i`` Save the video as gif ``--save_as_gif`` ``-i`` Save the video as gif
``--transparent`` ``-t`` Render to a movie file with an alpha channel ``--transparent`` ``-t`` Render to a movie file with an alpha channel
@ -58,7 +59,7 @@ flag abbr function
``--frame_rate FRAME_RATE`` Frame rate, as an integer ``--frame_rate FRAME_RATE`` Frame rate, as an integer
``--color COLOR`` ``-c`` Background color ``--color COLOR`` ``-c`` Background color
``--leave_progress_bars`` Leave progress bars displayed in terminal ``--leave_progress_bars`` Leave progress bars displayed in terminal
``--video_dir VIDEO_DIR`` directory to write video ``--video_dir VIDEO_DIR`` Directory to write video
``--config_file CONFIG_FILE`` Path to the custom configuration file ``--config_file CONFIG_FILE`` Path to the custom configuration file
========================================================== ====== ================================================================================================================================================================================================= ========================================================== ====== =================================================================================================================================================================================================

4
manimlib/config.py
View file

@ -23,7 +23,7 @@ def parse_cli():
module_location.add_argument( module_location.add_argument(
"file", "file",
nargs="?", nargs="?",
help="path to file holding the python code for the scene", help="Path to file holding the python code for the scene",
) )
parser.add_argument( parser.add_argument(
"scene_names", "scene_names",
@ -68,7 +68,7 @@ def parse_cli():
parser.add_argument( parser.add_argument(
"-p", "--presenter_mode", "-p", "--presenter_mode",
action="store_true", action="store_true",
help="scene will stay paused during wait calls until " help="Scene will stay paused during wait calls until "
"space bar or right arrow is hit, like a slide show" "space bar or right arrow is hit, like a slide show"
) )
parser.add_argument( parser.add_argument(