Skip to content

Add explanation for relevance attribute in license rule documentation #4877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nafisa404 wants to merge 1 commit into
base: develop
Choose a base branch
from
+14 −0
Open

Add explanation for relevance attribute in license rule documentation #4877

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/source/explanation/scancode-license-detection-updates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,20 @@ I.e. the identifier is a `RULE` or a `LICENSE` file.
Example: ``apache-2.0_2.RULE``

Other attributes are it's license-expression, the boolean fields, length, relevance etc.
Relevance
---------

The `relevance` attribute represents the importance of a rule when detecting
licenses. It acts as a scoring mechanism that helps ScanCode prioritize stronger
matches over weaker ones.

Rules with higher relevance values indicate stronger evidence that the matched
text corresponds to a specific license. For example, rules matching the main
license text usually have higher relevance, while rules matching smaller license
references or fragments may have lower values.

This scoring helps ScanCode select the most accurate license detection when
multiple rules match the same piece of text.


CLI option
Expand Down
Loading