improved documentation

Author: joshuabmoore

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyspi"
-version = "2.0.0"
+version = "2.0.1"
 authors = [
     { name ="Oliver M. Cliff", email="[email protected]"},
 ]

pyspi/calculator.py

@@ -27,19 +27,19 @@ class Calculator:
 
     Args:
         dataset (:class:`~pyspi.data.Data`, array_like, optional):
-            The multivariate time series of M processes and T observations, defaults to None.
+            The multivariate time series of M processes and T observations, default=None.
         name (str, optional):
-            The name of the calculator. Mainly used for printing the results but can be useful if you have multiple instances, defaults to None.
+            The name of the calculator. Mainly used for printing the results but can be useful if you have multiple instances, default=None.
         labels (array_like, optional):
-            Any set of strings by which you want to label the calculator. This can be useful later for classification purposes, defaults to None.
+            Any set of strings by which you want to label the calculator. This can be useful later for classification purposes, default=None.
         subset (str, optional):
-            A pre-configured subset of SPIs to use. Options are "all", "fast", "sonnet", or "fabfour", defaults to "all".
+            A pre-configured subset of SPIs to use. Options are "all", "fast", "sonnet", or "fabfour", default="all".
         configfile (str, optional):
             The location of the YAML configuration file for a user-defined subset. See :ref:`Using a reduced SPI set`, defaults to :code:`'</path/to/pyspi>/pyspi/config.yaml'`
         detrend (bool, optional):
-            If True, detrend each time series individually along the time axis before normalising (if enabled), defaults to False.
+            If True, detrend each time series in the MTS dataset individually along the time axis before normalising (if enabled), default=False.
         normalise (bool, optional):
-            If True, z-score normalise each time series in the MTS dataset individually along the time axis before computing SPIs, defaults to True.
+            If True, z-score normalise each time series in the MTS dataset individually along the time axis before computing SPIs, default=True.
     """
     _optional_dependencies = None
 

pyspi/data.py

@@ -42,17 +42,17 @@ class Data:
         dim_order (str, optional):
             Order of dimensions, accepts two combinations of the characters 'p', and 's' for processes and observations, defaults to 'ps'.
         detrend (bool, optional):
-            If True, detrend each time series individually along the time axis before normalising (if enabled), defaults to False.
+            If True, detrend each time series individually along the time axis before normalising (if enabled), default=False.
         normalise (bool, optional):
-            If True, z-score normalise each time series in the MTS dataset individually along the time axis before computing SPIs, defaults to True.
+            If True, z-score normalise each time series in the MTS dataset individually along the time axis before computing SPIs, default=True.
         name (str, optional):
             Name of the dataset
         procnames (list, optional):
-            List of process names with length the number of processes, defaults to None.
+            List of process names with length the number of processes, default=None.
         n_processes (int, optional):
-            Truncates data to this many processes, defaults to None.
+            Truncates data to this many processes, default=None.
         n_observations (int, optional):
-            Truncates data to this many observations, defaults to None.
+            Truncates data to this many observations, default=None.
 
     """
 

setup.py

@@ -64,7 +64,7 @@
                         'data/standard_normal.npy',
                         'data/cml7.npy']},
     include_package_data=True,
-    version='2.0.0',
+    version='2.0.1',
     description='Library for pairwise analysis of time series data.',
     author='Oliver M. Cliff',
     author_email='[email protected]',