Skip to content

Commit 49b0f3b

Browse files
committed
doc: small docstring improvements to gradient/laplacian
1 parent 8a202f2 commit 49b0f3b

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

pylops/basicoperators/gradient.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ class Gradient(LinearOperator):
2929
Derivative kind (``forward``, ``centered``, or ``backward``).
3030
dtype : :obj:`str`, optional
3131
Type of elements in input array.
32+
name : :obj:`str`, optional
33+
.. versionadded:: 2.0.0
34+
35+
Name of operator (to be used by :func:`pylops.utils.describe.describe`)
3236
3337
Attributes
3438
----------

pylops/basicoperators/laplacian.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class Laplacian(LinearOperator):
2121
----------
2222
dims : :obj:`tuple`
2323
Number of samples for each dimension.
24-
axes : :obj:`int`, optional
24+
axes : :obj:`tuple`, optional
2525
.. versionadded:: 2.0.0
2626
2727
Axes along which the Laplacian is applied.
@@ -37,6 +37,10 @@ class Laplacian(LinearOperator):
3737
Derivative kind (``forward``, ``centered``, or ``backward``)
3838
dtype : :obj:`str`, optional
3939
Type of elements in input array.
40+
name : :obj:`str`, optional
41+
.. versionadded:: 2.0.0
42+
43+
Name of operator (to be used by :func:`pylops.utils.describe.describe`)
4044
4145
Attributes
4246
----------
@@ -54,7 +58,7 @@ class Laplacian(LinearOperator):
5458
Raises
5559
------
5660
ValueError
57-
If ``axes``. ``weights``, and ``sampling`` do not have the same size
61+
If ``axes``, ``weights``, and ``sampling`` do not have the same size
5862
5963
Notes
6064
-----

0 commit comments

Comments
 (0)