Skip to content

Clarify default GUI usage #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
galjos merged 1 commit into from
Jul 27, 2026
Merged

Clarify default GUI usage #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion PQEnalyzer/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@ def main():
"""
parser = argparse.ArgumentParser(
prog="pqenalyzer",
usage=(
"%(prog)s [-h] [-v] [gui|tui] "
"[--pq | -q | --box | --opt] FILE [FILE ...]"
),
description="Plot and monitor PQ simulation output.",
epilog="Pass files directly to open the GUI: pqenalyzer FILE [FILE ...]",
)
Expand All @@ -98,7 +102,7 @@ def main():

subparsers = parser.add_subparsers(
dest="mode",
metavar="{gui,tui}",
metavar="[gui|tui]",
required=True,
)
gui_parser = subparsers.add_parser("gui", help="Open the GUI (default).")
Expand Down
6 changes: 5 additions & 1 deletion tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ def test_cli_help_mentions_gui_and_tui_modes():

assert result.returncode == 0
assert "Traceback" not in result.stderr
assert "{gui,tui}" in result.stdout
assert (
"usage: pqenalyzer [-h] [-v] [gui|tui] "
"[--pq | -q | --box | --opt] FILE [FILE ...]"
) in result.stdout
assert "{gui,tui}" not in result.stdout
assert "gui" in result.stdout
assert "tui" in result.stdout

Expand Down
Loading