Reformat usage string #46
Conversation
There was a problem hiding this comment.
Thanks for taking a look at this. I think there are a few things that you need to address here.
Sign-off Check
Thank you for reading the contributor guide. I think you have misunderstood the intent of the sign-off check, though. Please rewrite history to remove the commit with the certificate of origin. Your remaining commit should look like this:
Add newlines to argparse help strings
Signed-off-by: Youssef Ragab <[email protected]>
Formatting
Please install and run the pre-commit hooks:
pre-commit install
pre-commit run
If you need to run on a specific file:
pre-commit run --files codebasin.py
There are some formatting changes in your patch that don't look right to me, and this should fix them.
-h Option
The -h option still has the default string, with a lower-case "show":
optional arguments:
-h, --help show this help message and exit
codebasin.py
Outdated
| help=""" | ||
| Decrease verbosity level""", |
There was a problem hiding this comment.
This inserts a newline, but doesn't seem to do so consistently.
The "Increase" and "Decrease" lines have extra indentation compared to other options:
-r DIR, --rootdir DIR
Set working root directory (default .)
-c FILE, --config FILE
Configuration file (default: <DIR>/config.yaml)
-v, --verbose
Increase verbosity level
-q, --quiet
Decrease verbosity level
There was a problem hiding this comment.
Echoing @Pennycook comments, particularly regarding the guidelines laid out in the contributor's guide. Additionally, the CI check fails because commits are unsigned, so we are unable to merge it until that is done.
codebasin.py
Outdated
| @@ -49,8 +49,9 @@ def guess_project_name(config_path): | |||
| if __name__ == "__main__": | |||
| # Read command-line arguments | |||
| parser = argparse.ArgumentParser( | |||
| description="Code Base Investigator v" + str(version), | |||
| ) | |||
| description="Code Base Investigator v" + str(version), | |||
There was a problem hiding this comment.
black would modify this block
codebasin.py
Outdated
| ) | ||
| parser.add_argument( | ||
| "-v", | ||
| "--verbose", | ||
| dest="verbose", | ||
| action="count", | ||
| default=0, | ||
| help="increase verbosity level", | ||
| help=""" |
There was a problem hiding this comment.
black should modify this block
codebasin.py
Outdated
| ) | ||
| parser.add_argument( | ||
| "--batchmode", | ||
| dest="batchmode", | ||
| action="store_true", | ||
| default=False, | ||
| help="Set batch mode (additional output for bulk operation.)", | ||
| help=""" |
There was a problem hiding this comment.
black should modify this block
|
I see the issue, thank you both for the comments @laserkelvin @Pennycook, let me see if I can find a better way of doing this. |
Signed-off-by: Youssef Ragab <[email protected]>
…on now showing on new line with consistent indenting and formatting. Signed-off-by: Youssef Ragab <[email protected]>'
|
@youssefragab99 - Are you still working on this? Our next release is planned for the end of March, and we were hoping to have this fix included there. |
|
Closing as stale, and I'll open a new pull request to add the capital letters. I'll defer the formatting until the next release. |
Related issues
If applicable: N/A
Closes/Fixes/Addresses #<45>
If not applicable: write "N/A".
Proposed changes
List out—with high level descriptions—what the commits
within this PR do: