style: fix docstrings

Author: alycejenni

docs/_scripts/gen_api_pages.py

@@ -1,6 +1,5 @@
 # !/usr/bin/env python
 # encoding: utf-8
-
 """
 Generate the code reference pages and navigation.
 

splitgill/diffing.py

@@ -334,7 +334,7 @@ def patch(base: dict, ops: Collection[DiffOp]) -> dict:
 
     :param base: the starting dict
     :param ops: the DiffOps to apply to the base dict (can be pure tuples, doesn't have
-                to be DiffOp namedtuples)
+        to be DiffOp namedtuples)
     :return: a new dict with the changes applied
     """
     # nothing to do

splitgill/indexing/fields.py

@@ -76,7 +76,7 @@ def path_to(self, field: str, full: bool = True) -> str:
 
         :param field: the name (including dots if needed) of the field
         :param full: whether to prepend the parsed field name to the path or not
-                     (default: True)
+            (default: True)
         :return: the path
         """
         return parsed_path(field, self, full)
@@ -94,7 +94,7 @@ def parsed_path(
     :param field: the name (including dots if needed) of the field
     :param parsed_type: the parsed type (default: None)
     :param full: whether to prepend the parsed field name to the path or not (default:
-                 True)
+        True)
     :return: the path
     """
     if parsed_type is not None:
@@ -166,7 +166,7 @@ def add(self, type_names: str, count: int):
         Add the given type count data to this field.
 
         :param type_names: the types this field is seen as a string of their names
-                          separated by commas.
+            separated by commas.
         :param count: the number of records with this combination of types
         """
         self.count += count
@@ -179,7 +179,7 @@ def is_type(self, *data_types: DataType) -> bool:
 
         :param data_types: the data types to be checked
         :return: True if the field is an instance of one of the given data types, False
-                 if not
+            if not
         """
         return any(self.type_counts[data_type] > 0 for data_type in data_types)
 
@@ -290,7 +290,7 @@ def add(self, type_names: str, count: int):
         Add the given type count data to this field.
 
         :param type_names: the types this field is seen as a string of their names
-                          separated by commas.
+            separated by commas.
         :param count: the number of records with this combination of types
         """
         self.count += count
@@ -303,7 +303,7 @@ def is_type(self, *parsed_types: ParsedType) -> bool:
 
         :param parsed_types: the parsed types to be checked
         :return: True if the field is an instance of one of the given parsed types,
-                 False if not
+            False if not
         """
         return any(self.type_counts[parsed_type] > 0 for parsed_type in parsed_types)
 

splitgill/indexing/geo.py

@@ -94,7 +94,7 @@ def create_polygon_circle(
     :param longitude: a longitude float value
     :param radius_in_metres: a radius in metres value
     :param segments: the quad_segs parameter to pass when creating the circle around the
-                     point (the number of segments used will be 4*segments).
+        point (the number of segments used will be 4*segments).
     :return: a Polygon
     """
     if radius_in_metres <= 0:

splitgill/indexing/options.py

@@ -135,7 +135,7 @@ def with_geo_hint(
         :param longitude_field: the name of the longitude field
         :param radius_field: the name of the radius field (optional)
         :param segments: the number of segments to use when creating the circle
-                         (optional, defaults to 16)
+            (optional, defaults to 16)
         :return: self
         """
         if latitude_field and longitude_field:

splitgill/ingest.py

@@ -67,13 +67,12 @@ def generate_ops(
     :param data_collection: the data collection containing any existing records
     :param records: the records to generate insert/update ops for
     :param modified_field: optional field containing a modified date. If this parameter
-                           is specified, the check to see if there are any changes
-                           between the old and new versions of the data will ignore this
-                           field (if there are other fields that have changed, then a
-                           full diff is generated with these fields included). Defaults
-                           to None, indicating no modified field should be used.
+        is specified, the check to see if there are any changes between the old and new
+        versions of the data will ignore this field (if there are other fields that have
+        changed, then a full diff is generated with these fields included). Defaults to
+        None, indicating no modified field should be used.
     :param find_size: the number of records look up at a time. This corresponds directly
-                      to the size of the $in query ID list. Defaults to 100.
+        to the size of the $in query ID list. Defaults to 100.
     :return: yields bulk Mongo ops
     """
     # todo: refactor this, it's a bit messy
@@ -214,7 +213,7 @@ def revert_record(record: MongoRecord) -> Optional[UpdateOne]:
     returned as you shouldn't be reverting committed data, that breaks Splitgill!
 
     :return: an UpdateOne object if there was a previous version to revert to and
-             therefore the revert was completed, None if not
+        therefore the revert was completed, None if not
     """
     if not record.diffs or record.version is not None:
         return None

splitgill/locking.py

@@ -41,7 +41,7 @@ def acquire(self, lock_id: str, raise_on_fail: bool = False, **kwargs) -> bool:
 
         :param lock_id: the ID of the lock to acquire
         :param raise_on_fail: if True, raises an AlreadyLocked exception if the lock
-                              can't be acquired. Default: False.
+            can't be acquired. Default: False.
         :return: True if the lock was acquired, False if not
         """
         try:

splitgill/model.py

@@ -100,7 +100,7 @@ def iter(self) -> Iterable[VersionedData]:
         with the latest data and working back to the first version.
 
         :return: VersionedData (version: int, data: dict) named tuples in descending
-                 version order
+            version order
         """
         yield VersionedData(self.version, self.data)
         base = self.data

splitgill/search.py

@@ -253,7 +253,7 @@ def rebuild_dict_or_list(
     Rebuild a dict or a list inside the parsed dict.
 
     :param value: a dict which can either be for structure or a value, or a list of
-                  either value or structure dicts
+        either value or structure dicts
     :return: a dict, list, or value
     """
     if isinstance(value, dict):

splitgill/utils.py

@@ -20,7 +20,7 @@ def to_timestamp(moment: Union[datetime, date]) -> int:
 
     :param moment: a datetime or date object
     :return: the timestamp (number of milliseconds between the UNIX epoch and the
-             moment) as an int
+        moment) as an int
     """
     if isinstance(moment, datetime):
         return int(moment.timestamp() * 1000)
@@ -42,7 +42,7 @@ def parse_to_timestamp(
     :param datetime_format: the format as a string
     :param tz: the timezone to use (default: UTC)
     :return: the parsed datetime as the number of milliseconds since the UNIX epoch as
-             an int
+        an int
     """
     dt = datetime.strptime(datetime_string, datetime_format)
     if dt.tzinfo is None: