Skip to content

Commit 5fd622a

Browse files
committed
Add newlines to help strings
Intent is to make spacing consistent for short and long options. Signed-off-by: John Pennycook <john.pennycook@intel.com>
1 parent 3e8eae2 commit 5fd622a

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

bin/codebasin

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,35 +20,36 @@ def main():
2020
# Read command-line arguments
2121
parser = argparse.ArgumentParser(
2222
description="Code Base Investigator " + str(version),
23+
formatter_class=argparse.RawTextHelpFormatter,
2324
add_help=False,
2425
)
2526
parser.add_argument(
2627
"-h",
2728
"--help",
2829
action="help",
29-
help="Display help message and exit.",
30+
help="\nDisplay help message and exit.\n ",
3031
)
3132
parser.add_argument(
3233
"--version",
3334
action="version",
3435
version=f"Code Base Investigator {version}",
35-
help="Display version information and exit.",
36+
help="\nDisplay version information and exit.\n ",
3637
)
3738
parser.add_argument(
3839
"-v",
3940
"--verbose",
4041
dest="verbose",
4142
action="count",
4243
default=0,
43-
help="Increase verbosity level.",
44+
help="\nIncrease verbosity level.\n ",
4445
)
4546
parser.add_argument(
4647
"-q",
4748
"--quiet",
4849
dest="quiet",
4950
action="count",
5051
default=0,
51-
help="Decrease verbosity level.",
52+
help="\nDecrease verbosity level.\n ",
5253
)
5354
parser.add_argument(
5455
"-R",
@@ -58,9 +59,9 @@ def main():
5859
action="append",
5960
default=[],
6061
choices=["all", "summary", "clustering"],
61-
help="Generate a report of the specified type. "
62-
+ "May be specified multiple times. "
63-
+ "If not specified, all reports will be generated.",
62+
help="Generate a report of the specified type.\n"
63+
+ "May be specified multiple times.\n"
64+
+ "If not specified, all reports will be generated.\n ",
6465
)
6566
parser.add_argument(
6667
"-x",
@@ -69,8 +70,8 @@ def main():
6970
metavar="<pattern>",
7071
action="append",
7172
default=[],
72-
help="Exclude files matching this pattern from the code base. "
73-
+ "May be specified multiple times.",
73+
help="Exclude files matching this pattern from the code base.\n"
74+
+ "May be specified multiple times.\n ",
7475
)
7576
parser.add_argument(
7677
"-p",
@@ -79,14 +80,14 @@ def main():
7980
metavar="<platform>",
8081
action="append",
8182
default=[],
82-
help="Include the specified platform in the analysis. "
83-
+ "May be specified multiple times. "
84-
+ "If not specified, all platforms will be included.",
83+
help="Include the specified platform in the analysis.\n"
84+
+ "May be specified multiple times.\n"
85+
+ "If not specified, all platforms will be included.\n ",
8586
)
8687
parser.add_argument(
8788
"analysis_file",
8889
metavar="<analysis-file>",
89-
help="TOML file describing the analysis to be performed, "
90+
help="\nTOML file describing the analysis to be performed, "
9091
+ "including the codebase and platform descriptions.",
9192
)
9293

0 commit comments

Comments
 (0)