Skip to content

Commit 08c8aac

Browse files
Address feedback on docstrings and load/dump functions
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
1 parent 0b3338a commit 08c8aac

File tree

5 files changed

+53
-668
lines changed

5 files changed

+53
-668
lines changed

docs/source/cli-reference/other-commands.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,11 @@ reindex the licenses without these licenses from the additional plugins.
100100

101101
Rebuild the license index including texts all languages (and not only
102102
English) and exit. This is an EXPERIMENTAL option.
103+
104+
105+
``--load-dump`` Option
106+
^^^^^^^^^^^^^^^^^^^^^^
107+
108+
Load all licenses and rules from their respective files and then dump them
109+
to their respective files. This is done to make small formatting changes across
110+
all licenses and rules, to be consistent across them.

docs/source/rst_snippets/scancode-reindex-licenses.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ Options
1818
--additional-directory DIR Include this directory with additional custom
1919
licenses and license rules in the license
2020
detection index.
21+
--load-dump Load all license and rules from their respective
22+
files and then dump them back to those same files.
2123
-h, --help Shows the options and explanations.

0 commit comments

Comments
 (0)