Merge pull request #32 from nexB/26-update-docstrings-to-imperative-style

Update docstrings to imperative style #26

Author: steven-esser

src/deltacode/__init__.py

@@ -35,7 +35,7 @@
 
 class DeltaCode(object):
     """
-    Handles the basic operations on a pair of incoming ScanCode scans (in JSON
+    Handle the basic operations on a pair of incoming ScanCode scans (in JSON
     format) and the Delta objects created from a comparison of the files (in
     the form of File objects) contained in those scans.
     """
@@ -46,9 +46,9 @@ def __init__(self, new_path, old_path):
 
     def align_scan(self):
         """
-        Seeks to align the paths of a pair of files (File objects) in the pair
+        Seek to align the paths of a pair of files (File objects) in the pair
         of incoming scans so that the attributes and other characteristics of
-        the files can be compared with one another.  Calls utils.fix_trees(),
+        the files can be compared with one another.  Call utils.fix_trees(),
         which calls utils.align_trees().
         """
         try:
@@ -63,7 +63,7 @@ def determine_delta(self):
         """
         Given new and old scans, return an OrderedDict of Delta objects grouping
         the objects under the keys 'added', 'modified', 'removed' or 'unmodified'.
-        Returns None if no File objects can be loaded from either scan.
+        Return None if no File objects can be loaded from either scan.
         """
         if self.new.files is None or self.old.files is None:
             return None

src/deltacode/cli.py

@@ -71,11 +71,11 @@ def generate_json(delta, result_file):
 @click.option('-j', '--json-file', prompt=False, type=click.Path(exists=False), help='Identify the path to the .json output file')
 def cli(new, old, csv_file, json_file):
     """
-    This script identifies the changes that need to be made to the 'old'
+    Identify the changes that need to be made to the 'old'
     scan file (-o or -old) in order to generate the 'new' scan file (-n or
-    -new).  The results are written to a .csv file (-c or -csv-file) or a
+    -new).  Write the results to a .csv file (-c or -csv-file) or a
     .json file (-j or -json-file) at a user-designated location.  If no file
-    option is selected, the JSON results are printed to the console.
+    option is selected, print the JSON results to the console.
     """
     # do the delta
     delta = DeltaCode(new, old)

src/deltacode/models.py

@@ -32,7 +32,7 @@
 
 class Scan(object):
     """
-    Processes the files contained in an incoming ScanCode scan to test whether
+    Process the files contained in an incoming ScanCode scan to test whether
     they are valid, retrieve the scan's 'files_count' value, create a list of
     File objects, and generate a dictionary of File objects indexed by a
     selected key.