docs: fix reworked history

alexfikl · Jul 24, 2023 · 252e387 · 252e387
1 parent bb20db5
commit 252e387
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 7 deletions.
diff --git a/docs/fode.rst b/docs/fode.rst
@@ -8,10 +8,15 @@ Single-Term Fractional Ordinary Differential Equations
 History Handling
 ----------------
 
-.. autoclass:: StateHistory
-.. autoclass:: SourceHistory
+.. autoclass:: State
 .. autoclass:: History
 
+.. autoclass:: ProductIntegrationState
+.. autoclass:: VariableProductIntegrationHistory
+
+.. autoclass:: FixedState
+.. autoclass:: FixedSizeHistory
+
 Interface
 ---------
 
@@ -20,18 +25,20 @@ Interface
 .. autoclass:: StepCompleted
 
 .. autoclass:: FractionalDifferentialEquationMethod
+.. autoclass:: ProductIntegrationMethod
 
-.. autofunction:: make_initial_condition
 .. autofunction:: evolve
 .. autofunction:: advance
+.. autofunction:: make_initial_condition
 
 .. autofunction:: make_predict_time_step_fixed
 .. autofunction:: make_predict_time_step_graded
 
 Caputo Derivative FODEs
 =======================
 
-.. autoclass:: CaputoDifferentialEquationMethod
+.. autoclass:: CaputoProductIntegrationMethod
+
 .. autoclass:: CaputoForwardEulerMethod
 .. autoclass:: CaputoWeightedEulerMethod
 .. autoclass:: CaputoPredictorCorrectorMethod

diff --git a/docs/misc.rst b/docs/misc.rst
@@ -16,6 +16,11 @@ Jacobi Polynomials
 
 .. automodule:: pycaputo.jacobi
 
+Generating Functions
+--------------------
+
+.. automodule:: pycaputo.generating_functions
+
 Logging
 -------
 

diff --git a/pycaputo/derivatives.py b/pycaputo/derivatives.py
@@ -28,8 +28,8 @@ class FractionalOperator:
     """
 
     #: Order of the fractional operator, as real number
-    # :math:`\alpha \in \mathbb{R}`. A positive number would denote a derivative,
-    # while a negative number would denote a fractional integral instead.
+    #: :math:`\alpha \in \mathbb{R}`. A positive number would denote a derivative,
+    #: while a negative number would denote a fractional integral instead.
     order: float
 
     @property

diff --git a/pycaputo/fode/__init__.py b/pycaputo/fode/__init__.py
@@ -22,6 +22,7 @@
 )
 from pycaputo.fode.history import (
     FixedSizeHistory,
+    FixedState,
     History,
     ProductIntegrationState,
     State,
@@ -43,6 +44,7 @@
     "CaputoWeightedEulerMethod",
     "Event",
     "FixedSizeHistory",
+    "FixedState",
     "FractionalDifferentialEquationMethod",
     "History",
     "ProductIntegrationMethod",

diff --git a/pycaputo/fode/history.py b/pycaputo/fode/history.py
@@ -47,7 +47,7 @@ def __len__(self) -> int:
     @abstractmethod
     def __getitem__(self, k: int) -> State:
         """
-        :returns: a :class:`StateHistory` from the *k*-th checkpoint.
+        :returns: a compound :class:`State` from the *k*-th checkpoint.
         """
 
     @abstractmethod