Skip to content
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.

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

Help message for x.py #1469

Open
fpoli opened this issue Oct 27, 2023 · 0 comments
Open

Help message for x.py #1469

fpoli opened this issue Oct 27, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@fpoli
Copy link
Member

fpoli commented Oct 27, 2023

The x.py script interprets its subcommands and arguments using some custom parsing rules, but discovering them is difficult because the script does not print any help message.

  • x.py and x.py --help should print a proper help message, listing the possible subcommands and a 1-line description for each of them. This can be done by replacing the parser with one defined using the argparse library.
  • The arguments after a subcommand should be passed as they are to the corresponding command. For example, x.py build --help should execute cargo build --help instead of printing a help message from Python.
  • x.py should not require to install new Python dependencies (so, no click for example).
@fpoli fpoli added enhancement New feature or request good first issue Good for newcomers labels Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant