Decoding all members.

Author: malcolmmackay

docs/reference/decoder/index.rst

@@ -7,24 +7,30 @@ Decode a cuplcodec URL
 The decoder extracts a timestamped list of samples from a cuplcodec URL.
 
 .. automodule:: wscodec.decoder.decoderfactory
+    :members:
     :private-members:
 
 .. inheritance-diagram:: wscodec.decoder.hdc2021.TempRH_URL wscodec.decoder.hdc2021.Temp_URL
    :parts: 2
 
 .. autoclass:: wscodec.decoder.hdc2021.TempRH_URL
+    :members:
     :private-members:
 
 .. autoclass:: wscodec.decoder.hdc2021.Temp_URL
+    :members:
     :private-members:
 
 .. autoclass:: wscodec.decoder.samples.SamplesURL
+    :members:
     :private-members:
 
 .. autoclass:: wscodec.decoder.pairs.PairsURL
+    :members:
     :private-members:
 
 .. automodule:: wscodec.decoder.circularbuffer
+    :members:
     :private-members:
 
 Sample
@@ -34,24 +40,29 @@ Sample
    :parts: 2
 
 .. autoclass:: wscodec.decoder.hdc2021.TempRHSample
+    :members:
     :private-members:
 
 .. autoclass:: wscodec.decoder.hdc2021.TempSample
+    :members:
     :private-members:
 
 .. autoclass:: wscodec.decoder.samples.Sample
+    :members:
     :private-members:
 
 Pair
 -----
 
 .. autoclass:: wscodec.decoder.pairs.Pair
+    :members:
     :private-members:
 
 Status
 -------
 
 .. automodule:: wscodec.decoder.status
+    :members:
     :private-members:
 
 

wscodec/decoder/circularbuffer.py

@@ -6,18 +6,23 @@
 
 class CircularBufferURL:
     """
+    Base class for a cuplcodec URL.
 
+    This includes at least a circular buffer with a long string of base64 encoded sample data and
+    a short status field.
+
+    Instantiation decodes the status string. This must be done first because it contains error information.
+
+    Parameters
+        ----------
+        statb64 : str
+        circb64 : str
     """
     ELAPSED_LEN_BYTES = 4   #: Length of the endstop elapsed minutes field in bytes (including the endstop itself).
     ENDSTOP_LEN_BYTES = 16  #: Length of the endstop in bytes.
     ENDSTOP_BYTE = '~'      #: The last character in the endstop and the end of the circular buffer. Must be URL safe.
 
     def __init__(self, statb64: str, circb64: str = None):
-        """
-
-        :param statb64:
-        :param circb64:
-        """
         self.statb64 = statb64
         self.circb64 = circb64