Improve docstrings for pipelines

Suggested-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

scanpipe/pipelines/load_sbom.py

@@ -26,12 +26,13 @@
 
 class LoadSBOM(ScanCodebase):
     """
-    Detects and loads all associated packages from SBOMs.
+    Load package data from one or more SBOMs.
 
     Supported BOMs:
     - SPDX document
     - CycloneDX BOM
-    - AboutCode ABOUT file
+    Other formats:
+    - AboutCode .ABOUT files for package curations.
     """
 
     @classmethod

scanpipe/pipelines/resolve_dependencies.py

@@ -26,15 +26,15 @@
 
 class ResolveDependencies(ScanCodebase):
     """
-    Resolve dependencies from package manifests/lockfiles.
+    Resolve dependencies from packages manifests and lockfiles.
 
-    This pipeline inspects codebase lockfiles/manifest files
-    which contain package requirements and resolve their
-    associated packages.
+    This pipeline collects lockfiles and manifest files
+    that contain dependencies requirements and resolve these
+    to a concrete set of package versions.
 
-    Supports resolved packages for:
-    - Python: using nexB/python-inspector, supports requirements.txt and
-    setup.py manifests as input
+    Supports resolving packages for:
+    - Python: using python-inspector, using requirements.txt and
+    setup.py manifests as inputs
     """
 
     @classmethod
@@ -50,10 +50,7 @@ def steps(cls):
         )
 
     def get_manifest_inputs(self):
-        """
-        Locate all the package manifest files for which package resolvers are
-        supported, in the codebase resources.
-        """
+        """Locate package manifest files with a supported package resolver."""
         self.manifest_resources = resolve.get_manifest_resources(self.project)
 
     def get_packages_from_manifest(self):

scanpipe/pipelines/scan_codebase.py

@@ -32,7 +32,7 @@ class ScanCodebase(Pipeline):
 
     This pipeline does not further scan the files contained in a package
     for license and copyrights and only considers the declared license
-    of a package.
+    of a package. It does not scan for system (Linux distro) packages.
     """
 
     @classmethod

scanpipe/pipelines/scan_single_package.py

@@ -36,7 +36,7 @@
 
 class ScanSinglePackage(Pipeline):
     """
-    Scan a single package file or package archive.
+    Scan a single package archive (or package manifest file).
 
     This pipeline scans a single package for package
     metadata, declared dependencies, licenses, and copyrights.