Refine docstring and add CHANGELOG entry #688

Signed-off-by: Thomas Druez <tdruez@nexb.com>

Author: tdruez

CHANGELOG.rst

@@ -4,6 +4,14 @@ Changelog
 v33.0.0 (unreleased)
 --------------------
 
+- Add a new ``develop_to_deploy`` pipeline specialized in creating relations between
+  the development source code and binaries or deployed code.
+  This pipeline is expecting 2 archive files with "from-" and "to-" filename prefixes
+  as inputs:
+  1. "from-[FILENAME]" archive containing the development source code
+  2. "to-[FILENAME]" archive containing the deployment compiled code
+  https://github.com/nexB/scancode.io/issues/659
+
 - Add new command line option to create-project and add-input management commands to
   copy the content of a local source directory to the project codebase work directory.
   https://github.com/nexB/scancode.io/pull/672

scanpipe/pipelines/develop_to_deploy.py

@@ -30,7 +30,14 @@
 
 
 class DevelopToDeploy(Pipeline):
-    """Relate develop and deploy code tree."""
+    """
+    Relate develop and deploy code trees.
+
+    This pipeline is expecting 2 archive files with "from-" and "to-" filename
+    prefixes as inputs:
+    - "from-[FILENAME]" archive containing the development source code
+    - "to-[FILENAME]" archive containing the deployment compiled code
+    """
 
     @classmethod
     def steps(cls):