Clean up comments for SPDX files

This commit adds and cleans up comments in spdx-related files.

Signed-off-by: Rose Judge <[email protected]>

Author: rnjudge

tern/formats/spdx/spdx_common.py

@@ -52,8 +52,10 @@ def is_spdx_license_expression(license_data):
         license_data = license_data.replace(',', ' and ')
     return licensing.validate(license_data).errors == []
 
-# Searches for declared license data using the license_expression library
 def get_package_license_declared(package_license_declared):
+    '''Determines if the declared license string for a package or file is a
+    valid SPDX license expression using the license_expression library. If not,
+    returns the SPDX LicenseRef or NONE if the string is blank.'''
     if package_license_declared:
         if is_spdx_license_expression(package_license_declared):
             return package_license_declared

tern/formats/spdx/spdxjson/file_helpers.py

@@ -49,7 +49,8 @@ def get_file_dict(filedata, template, layer_id):
     else:
         file_license_refs = []
         for lic in spdx_common.get_file_licenses(filedata):
-            # Add the LicenseRef to the list instead of license expression
+            # Add the license expression to the list if it is a valid SPDX
+            # identifier; otherwise, add the LicenseRef
             file_license_refs.append(spdx_common.get_package_license_declared(lic))
         file_dict['licenseInfoInFiles'] = file_license_refs
 

tern/formats/spdx/spdxtagvalue/file_helpers.py

@@ -34,6 +34,8 @@ def get_license_info_block(filedata):
         block = 'LicenseInfoInFile: NONE\n'
     else:
         for lic in spdx_common.get_file_licenses(filedata):
+            # Add the license expression to the list if it is a valid SPDX
+            # identifier; otherwise, add the LicenseRef
             block = block + 'LicenseInfoInFile: {}'.format(
                 spdx_common.get_package_license_declared(lic)) + '\n'
     return block