add a clarifying comment to [pypi] getLicenses (#8718)

badges · Dec 15, 2022 · a276770 · a276770
1 parent 61dd6c0
commit a276770
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/services/pypi/pypi-helpers.js b/services/pypi/pypi-helpers.js
@@ -50,6 +50,16 @@ function getLicenses(packageData) {
   const {
     info: { license },
   } = packageData
+
+  /*
+  The .license field may either contain
+  - a short license description (e.g: 'MIT' or 'GPL-3.0') or
+  - the full text of a license
+  but there is nothing in the response that tells us explicitly.
+  We have to make an assumption based on the length.
+  See https://github.com/badges/shields/issues/8689 and
+  https://github.com/badges/shields/pull/8690 for more info.
+  */
   if (license && license.length < 40) {
     return [license]
   } else {