chore: update command descriptions

This commit is contained in:
Xyphuz 2022-05-15 19:18:10 +08:00
parent 7f59cebb85
commit 0e9afd8133

View file

@ -27,23 +27,23 @@ def _version_callback(value: bool) -> None:
@app.callback() @app.callback()
def compose_viz( def compose_viz(
input_path: str, input_path: str,
output_path: Optional[str] = typer.Option( output_path: str = typer.Option(
None, "./compose-viz.png",
"--output_path", "--output-path",
"-o", "-o",
help="Output path for the generated visualization.", help="Output path for the generated visualization file.",
), ),
format: VisualizationFormats = typer.Option( format: VisualizationFormats = typer.Option(
"PNG", "PNG",
"--format", "--format",
"-m", "-m",
help="Output format for the generated visualization.", help="Output format for the generated visualization file.",
), ),
_: Optional[bool] = typer.Option( _: Optional[bool] = typer.Option(
None, None,
"--version", "--version",
"-v", "-v",
help="Show the version of compose_viz.", help="Show the version of compose-viz.",
callback=_version_callback, callback=_version_callback,
is_eager=True, is_eager=True,
) )
@ -58,4 +58,4 @@ def compose_viz(
def start_cli() -> None: def start_cli() -> None:
app(prog_name=__app_name__) app(prog_name="cpv")