Skip to content

Commit 259eb01

Browse files
Add CHANGELOG entry for --todo option
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent faf24c3 commit 259eb01

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

CHANGELOG.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,17 @@ we changed some of the command line options.
2727
The output format version is now 3.0.0.
2828

2929

30+
Other updates
31+
~~~~~~~~~~~~~
32+
33+
- We have a new ``--todo`` CLI option to have todo items for reviewers
34+
with ambiguous license detections and package detections.
35+
This adds a new codebase-level attribute ``todo`` which is a list
36+
of ambiguous detections. Here the ambiguous detection attributes are:
37+
- detection_id: same license unique license detection identifier or top-level
38+
package identifier.
39+
- detection: this is either a license_detection or a package_data mapping.
40+
- review_comments: to explain the type of ambiguous detections.
3041

3142
Package detection:
3243
~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)