Documents for scancode-license-data #4024
#4461
Conversation
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Chin Yeung Li <tli@nexb.com>
This commit also alphabetizes the options list and reorders `scancode-reindex-licenses` options to match the help output. Signed-off-by: Chin Yeung Li <tli@nexb.com>
There was a problem hiding this comment.
Thanks @chinyeungli looks good.
See my comments for your consideration
| @@ -1,23 +1,23 @@ | |||
| ``scancode-reindex-licenses`` Usage | |||
| ----------------------------------- | |||
|
|
|||
| Usage: ``scancode-reindex-licenses [OPTIONS]`` | |||
There was a problem hiding this comment.
Isn't CLI scripts/othe CLI commands best be wrapped by `` so they are highlighted differently?
| .. include:: /rst_snippets/scancode-license-data.rst | ||
|
|
||
|
|
||
| ``--path`` Option: |
There was a problem hiding this comment.
This should be inside scancode-license-data.rst
| .. include:: /rst_snippets/scancode-license-data.rst | ||
|
|
||
|
|
||
| ``--path`` Option: |
There was a problem hiding this comment.
This should be inside scancode-license-data.rst
| ``--path`` Option: | ||
| ^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| The ``--path`` option defines the directory where the license data will be stored. |
There was a problem hiding this comment.
Minor, but could you add a line that this is a mandatory option
|
|
||
| The dumped licenses directory look like this:: | ||
|
|
||
| licenses/ |
There was a problem hiding this comment.
Could you also explain that this is available online at scancode-licensedb.aboutcode.org/ (generated from https://github.com/aboutcode-org/scancode-licensedb which is refreshed automatically from scancode each day on new commits) and that someone can open this on their browser locally after using scancode-license-data by doing see /path/index.html
There was a problem hiding this comment.
someone can open this on their browser locally after using scancode-license-data by doing see /path/index.html
I don't understand what does this mean?
Perhaps I can simply say The license data is also avaliable at https://scancode-licensedb.aboutcode.org/ ?
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Fixes #4024 - Added documentation for
scancode-license-dataTasks
Run tests locally to check for errors.
The failing tests don't related to the documentation updated in this PR.
Signed-off-by: Chin Yeung Li tli@nexb.com