Add missing documentation (#285)

* Add missing `meshplot` documentation * Fix docstring for `binary_blobs3d`
hpgem · Jun 7, 2022 · 0f0e4e1 · 0f0e4e1
1 parent 396fbff
commit 0f0e4e1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/api.plotting.rst b/docs/api.plotting.rst
@@ -24,8 +24,9 @@ These plotting functions are currently available:
 Reference
 ---------
 
-.. autofunction:: linetrianglemeshplot
+.. autofunction:: meshplot
 .. autofunction:: linemeshplot
-.. autofunction:: lineplot
 .. autofunction:: trianglemeshplot
+.. autofunction:: linetrianglemeshplot
+.. autofunction:: lineplot
 .. autofunction:: pointsplot
diff --git a/nanomesh/data/__init__.py b/nanomesh/data/__init__.py
@@ -37,7 +37,7 @@ def binary_blobs2d(**kwargs) -> np.ndarray:
     return binary_blobs(**kwargs).astype(int)
 
 
-@doc(dim='3d')
+@doc(binary_blobs2d, dim='3d')
 def binary_blobs3d(**kwargs) -> np.ndarray:
     kwargs.setdefault('length', 50)
     kwargs.setdefault('n_dim', 3)