Update docs

curveresearch · Jul 10, 2023 · 586cb54 · 586cb54
1 parent d74df49
commit 586cb54
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/curvesim/iterators/param_samplers/grid.py b/curvesim/iterators/param_samplers/grid.py
@@ -54,7 +54,7 @@ class CurveMetaPoolGrid(Grid, CurveMetaPoolMixin):
 
 class CurveCryptoPoolGrid(Grid, CurveCryptoPoolMixin):
     """
-    :class:`Grid` parameter sampler specialized for Curve meta-pools.
+    :class:`Grid` parameter sampler specialized for Curve crypto pools.
     """
 
     pass
diff --git a/docs/api.rst b/docs/api.rst
@@ -171,15 +171,18 @@ Iterators
         :special-members: __iter__
         :inherited-members:
 
-    .. autoclass:: curvesim.iterators.param_samplers.CurvePoolGrid
-        :exclude-members: __new__
+    .. class:: curvesim.iterators.param_samplers.CurvePoolGrid
 
-    .. autoclass:: curvesim.iterators.param_samplers.CurveMetaPoolGrid
-        :exclude-members: __new__
+        :class:`Grid` parameter sampler specialized for Curve pools.
 
-    .. autoclass:: curvesim.iterators.param_samplers.CurveCryptoPoolGrid
-        :exclude-members: __new__
 
+    .. class:: curvesim.iterators.param_samplers.CurveMetaPoolGrid
+
+        :class:`Grid` parameter sampler specialized for Curve meta-pools.
+
+    .. class:: curvesim.iterators.param_samplers.CurveCryptoPoolGrid
+
+        :class:`Grid` parameter sampler specialized for Curve crypto pools.
 
     Price Samplers
     --------------