Skip to content

Commit 8cd7767

Browse files
committed
update the syntax wording
1 parent 12d30f9 commit 8cd7767

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

README.rst

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -74,24 +74,20 @@ USAGE
7474
-----
7575
The ABOUT tool command syntax is::
7676

77-
$ python about.py [--options] <input> <output>
78-
79-
[--options]
80-
--overwrite Overwrites the output file if it exists
81-
-v,--version Display current version, license notice, and copyright notice
82-
-h,--help Display syntax help
83-
--verbosity <arg> Print more or less verbose messages while processing ABOUT files
84-
<arg>
85-
0 - Do not print any warning or error messages, just a total count (default)
86-
1 - Print error messages
87-
2 - Print error and warning messages
88-
89-
<input> - Path location where the .ABOUT file(s) located.
90-
The location can be pointing to a file or directory.
91-
92-
<output> - Path location where the generated output will be saved.
93-
The <output> must be a path with an output filename ending
94-
with the ".csv" extension.
77+
Usage: about.py [options] input_path output_path
78+
79+
Input can be a file or directory.
80+
Output must be a file with a .csv extension.
81+
82+
Options:
83+
-h, --help Display help
84+
--version Display current version, license notice, and copyright notice
85+
--overwrite Overwrites the output file if it exists
86+
--verbosity=VERBOSITY
87+
Print more or fewer verbose messages while processing ABOUT files
88+
0 - Do not print any warning or error messages, just a total count (default)
89+
1 - Print error messages
90+
2 - Print error and warning messages
9591

9692
Example::
9793

0 commit comments

Comments
 (0)