Improve docstrings

src/aa_remove_data/pb_utils.py

@@ -64,8 +64,10 @@ def _restore_newline_chars(self, data: bytes) -> bytes:
         return data
 
     def _get_proto_class_name(self) -> str:
-        """Convert the name of a pv type to CamelCase to match the proto class
-        name.
+        """Convert the name of a pv type to match the proto class name. This
+        involves coverting to CamelCase and replacing 'WAVEFORM' with 'Vector'.
+        The full mapping is described in
+        epicsarchiverap/src/main/edu/stanford/slac/archiverappliance/PB/data/DBR2PBTypeMapping.java
 
         Returns:
             str: Name of proto class, e.g VectorDouble.

src/aa_remove_data/remove_data.py

@@ -66,9 +66,10 @@ def reduce_freq(
     or period (not both).
 
     Args:
-        samples (list): _description_
+        samples (list): List of samples
         freq (float, optional): Desired frequency. Defaults to 0.
         period (float, optional): Desired period. Defaults to 0.
+        initial_sample (type, optional): An initial sample to find an initial diff.
 
     Returns:
         list: Reduced list of samples
@@ -180,6 +181,7 @@ def keep_every_nth(
         samples (list): List of samples
         n (int): Every nth sample (or block of samples) will be kept.
         block_size (int, optional): Number of samples per block. Defaults to 1.
+        initial (int, optional): End point of processing from a previous chunk.
 
     Returns:
         list: Reduced list of samples.
@@ -209,6 +211,7 @@ def remove_every_nth(
         samples (list): List of samples
         n (int): Every nth sample (or block of samples) will be removed.
         block_size (int, optional): Number of samples per block. Defaults to 1.
+        initial (int, optional): End point of processing from a previous chunk.
 
     Returns:
         list: Reduced list of samples.