Update licensedcode/README.rst

[AyanSinhaMahapatra]

Description

A brief description of the Documentation Improvement or New Section request.

The licensedcode/README file is slightly outdated and needs to be updated.

Link to Documentation Page

Where the confusion/inconsistency/incomplete documentation is.

https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/README.rst

Select Category

• Inconsistency
• New Section Request
• General Improvement
• Typo/Mistakes
• Other

@pombredanne You asked me to open this ticket in one of our previous discussions.

[AyanSinhaMahapatra]

New Changes would possibly be -

1. The score != match_coverage * rule_relevance case, where there are extra words.
2. Add this page to the ReadTheDocs documentation (I'll be doing this)

Etc

[soumy47]

Hey @AyanSinhaMahapatra , I would like to work on this issue. Could you please guide me?

[AyanSinhaMahapatra]

Hey @soumy47, so this entails looking into src/licensedcode/README.rst and into the code in all licensedcode source files, to see in what areas the documentation could be updated (as this was last edited long before), and update them. The basic steps are the same in most cases, but some details/changes could be added. IMHO this is fairly complicated (to me) though, so feel free to take on other issues on license detection first.

[soumy47]

Thanks for the reply @AyanSinhaMahapatra. could you please tell me where can I find the source files of licensedcode? I'm new to open source but I'll try to do my best.

[sritasngh]

Hey @AyanSinhaMahapatra, does this issue come under good first issue? also if yes, can I create a pull request for issue All Good First Issues List #1825? Thankyou:)

[chinyeungli]

@AyanSinhaMahapatra I've updated the README under licensedcode . I've updated the score based on the wording from https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/licensedcode/detection.py#L404

Is there any specific area that need to be updated or need more information?