fixing cli pr_url help description

This commit is contained in:
Itamar Friedman
2023-08-10 01:30:12 +03:00
parent e00500b90c
commit 725ac9e85d

View File

@ -10,13 +10,13 @@ from pr_agent.config_loader import get_settings
def run(inargs=None): def run(inargs=None):
parser = argparse.ArgumentParser(description='AI based pull request analyzer', usage= parser = argparse.ArgumentParser(description='AI based pull request analyzer', usage=
"""\ """\
Usage: cli.py --pr-url <URL on supported git hosting service> <command> [<args>]. Usage: cli.py --pr-url=<URL on supported git hosting service> <command> [<args>].
For example: For example:
- cli.py --pr-url=... review - cli.py --pr_url=... review
- cli.py --pr-url=... describe - cli.py --pr_url=... describe
- cli.py --pr-url=... improve - cli.py --pr_url=... improve
- cli.py --pr-url=... ask "write me a poem about this PR" - cli.py --pr_url=... ask "write me a poem about this PR"
- cli.py --pr-url=... reflect - cli.py --pr_url=... reflect
Supported commands: Supported commands:
review / review_pr - Add a review that includes a summary of the PR and specific suggestions for improvement. review / review_pr - Add a review that includes a summary of the PR and specific suggestions for improvement.
@ -27,7 +27,7 @@ reflect - Ask the PR author questions about the PR.
update_changelog - Update the changelog based on the PR's contents. update_changelog - Update the changelog based on the PR's contents.
To edit any configuration parameter from 'configuration.toml', just add -config_path=<value>. To edit any configuration parameter from 'configuration.toml', just add -config_path=<value>.
For example: '- cli.py --pr-url=... review --pr_reviewer.extra_instructions="focus on the file: ..."' For example: 'python cli.py --pr_url=... review --pr_reviewer.extra_instructions="focus on the file: ..."'
""") """)
parser.add_argument('--pr_url', type=str, help='The URL of the PR to review', required=True) parser.add_argument('--pr_url', type=str, help='The URL of the PR to review', required=True)
parser.add_argument('command', type=str, help='The', choices=commands, default='review') parser.add_argument('command', type=str, help='The', choices=commands, default='review')