Merge pull request #2763 from zacchiro/feature/get_licenses-docstring

api.get_licenses: clarify and improve docstring for "min_score" argument

Author: pombredanne

AUTHORS.rst

@@ -93,3 +93,4 @@ The following organizations or individuals have contributed to ScanCode:
 - Yash Nisar @yash-nisar
 - Yash Sharma @yasharmaster
 - Yunus Rahbar @yns88
+- Stefano Zacchiroli @zacchiro

src/scancode/api.py

@@ -154,9 +154,9 @@ def get_licenses(location, min_score=0,
      - 'license_expressions' with a value that is list of license expression
        strings.
 
-    `minimum_score` is a minimum score threshold from 0 to 100. The default is 0
-    means that all license matches are returned. Otherwise, matches with a score
-    below `minimum_score` are returned.
+    `min_score` is a minimum score threshold from 0 to 100. The default is 0,
+    meaning that all license matches are returned. If specified, matches with a
+    score lower than `minimum_score` are not returned.
 
     If `include_text` is True, matched text is included in the returned
     `licenses` data as well as a file-level `percentage_of_license_text` percentage to