Skip to content

Commit f29ef87

Browse files
committed
style/docs: fix argument help style and update docs for it
1 parent fc1e916 commit f29ef87

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/source/getting_started/configuration.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ flag abbr function
4343
``--hd`` Render at a 1080p quality
4444
``--uhd`` Render at a 4k quality
4545
``--full_screen`` ``-f`` Show window in full screen
46+
``--presenter_mode`` ``-p`` Scene will stay paused during wait calls until space bar or right arrow is hit, like a slide show
4647
``--save_pngs`` ``-g`` Save each frame as a png
4748
``--save_as_gif`` ``-i`` Save the video as gif
4849
``--transparent`` ``-t`` Render to a movie file with an alpha channel
@@ -58,7 +59,7 @@ flag abbr function
5859
``--frame_rate FRAME_RATE`` Frame rate, as an integer
5960
``--color COLOR`` ``-c`` Background color
6061
``--leave_progress_bars`` Leave progress bars displayed in terminal
61-
``--video_dir VIDEO_DIR`` directory to write video
62+
``--video_dir VIDEO_DIR`` Directory to write video
6263
``--config_file CONFIG_FILE`` Path to the custom configuration file
6364
========================================================== ====== =================================================================================================================================================================================================
6465

manimlib/config.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ def parse_cli():
2323
module_location.add_argument(
2424
"file",
2525
nargs="?",
26-
help="path to file holding the python code for the scene",
26+
help="Path to file holding the python code for the scene",
2727
)
2828
parser.add_argument(
2929
"scene_names",
@@ -68,7 +68,7 @@ def parse_cli():
6868
parser.add_argument(
6969
"-p", "--presenter_mode",
7070
action="store_true",
71-
help="scene will stay paused during wait calls until "
71+
help="Scene will stay paused during wait calls until "
7272
"space bar or right arrow is hit, like a slide show"
7373
)
7474
parser.add_argument(

0 commit comments

Comments
 (0)