Skip to content

Commit d0fa8ec

Browse files
committed
Update help text for gen_license
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent c3a6363 commit d0fa8ec

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

docs/source/reference.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ Options
421421
Purpose
422422
-------
423423

424-
Fetch licenses in the license_expression field and save to the output location.
424+
Fetch licenses (Default: ScanCode LicenseDB) in the license_expression field and save to the output location.
425425

426426
Details
427427
^^^^^^^
@@ -453,6 +453,10 @@ Details
453453
This option tells the tool to show all errors found.
454454
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
455455
456+
Special Notes
457+
-------------
458+
If no `--djc` option is set, the tool will default to fetch licenses from ScanCode LicenseDB.
459+
456460
inventory
457461
=========
458462

src/attributecode/cmd.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ def gen(location, output, android, fetch_license, fetch_license_djc, reference,
312312
@click.help_option('-h', '--help')
313313
def gen_license(location, output, djc, scancode, verbose):
314314
"""
315-
Fetch licenses in the license_expression field and save to the output location.
315+
Fetch licenses (Default: ScanCode LicenseDB) in the license_expression field and save to the output location.
316316
317317
LOCATION: Path to a JSON/CSV/Excel/.ABOUT file(s)
318318

tests/testdata/test_cmd/help/about_gen_license_help.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Usage: about gen-license [OPTIONS] LOCATION OUTPUT
22

3-
Fetch licenses in the license_expression field and save to the output
4-
location.
3+
Fetch licenses (Default: ScanCode LicenseDB) in the license_expression field
4+
and save to the output location.
55

66
LOCATION: Path to a JSON/CSV/Excel/.ABOUT file(s)
77

0 commit comments

Comments
 (0)