Skip to content

Commit e0f8bee

Browse files
authored
Text edits
Changed "user" to "you" with associated changes. Streamlined some other text.
1 parent 852dfb7 commit e0f8bee

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

USAGE.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Options
7272

7373
--inventory
7474

75-
This option allows user to define which ABOUT files should be used for attribution generation.
75+
This option allows you to define which ABOUT files should be used for attribution generation.
7676
For instance,
7777
'/home/project/component_list.csv' is the inventory that user want to be generated
7878

@@ -84,19 +84,19 @@ Options
8484

8585
--show-all
8686

87-
This option ask the tool to show all kind of errors found.
87+
This option tells the tool to show all errors found.
8888
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
8989

9090
--template
9191

92-
This option allows users to use their own template for attribution generation.
93-
For instance, if user has a custom template located at:
92+
This option allows you to use your own template for attribution generation.
93+
For instance, if you have a custom template located at:
9494
/home/custom_template/template.html
9595

9696
$ about attrib --template /home/custom_template/template.html LOCATION OUTPUT
9797

9898

99-
The following information are passed to the jinja2 and, therefore, can be used for your custom template:
99+
The following data are passed to jinja2 and, therefore, can be used for a custom template:
100100
* about object: the about objects
101101
* common_licenses: a common license keys list in licenses.py
102102
* license_key_and_context: a dictionary list with license_key as a key and license text as the value
@@ -133,7 +133,7 @@ Options
133133

134134
--show-all
135135

136-
This option ask the tool to show all kind of errors found.
136+
This option tells the tool to show all errors found.
137137
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
138138

139139
$ about check --show-all /home/project/about_files/
@@ -193,7 +193,7 @@ Options
193193
This option requires 2 parameters:
194194
api_url - URL to the DJE License Library
195195
api_key - Hash key to authenticate yourself in the API.
196-
(Please contact us to get the api_* value to use this feature)
196+
(Please contact nexB to get the api_* value to use for this feature)
197197

198198
$ about gen --fetch-license 'api_url' 'api_key' LOCATION OUTPUT
199199

@@ -203,7 +203,7 @@ Options
203203
'license_file' and 'notice_file' value in the input from the directory
204204

205205
For instance,
206-
the directory, /home/licenses_notices/, contains all the licenses and notices that users want:
206+
the directory, /home/licenses_notices/, contains all the licenses and notices that you want:
207207
/home/license/apache2.LICENSE
208208
/home/license/jquery.js.NOTICE
209209

@@ -215,7 +215,7 @@ Options
215215

216216
--show-all
217217

218-
This option ask the tool to show all kind of errors found.
218+
This option tells the tool to show all errors found.
219219
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
220220

221221

@@ -260,7 +260,7 @@ Options
260260

261261
--show-all
262262

263-
This option ask the tool to show all kind of errors found.
263+
This option tells the tool to show all errors found.
264264
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
265265

266266
$ about inventory -f json [OPTIONS] LOCATION OUTPUT

0 commit comments

Comments
 (0)