Skip to content

Commit 21bf214

Browse files
committed
minor: add full stops to shape docstring
1 parent 1a7c595 commit 21bf214

64 files changed

Lines changed: 94 additions & 82 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

pylops/avo/avo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,7 @@ class AVOLinearModelling(LinearOperator):
620620
621621
For example, ``y_reshaped = (Op * x.ravel()).reshape(Op.dimsd)``.
622622
shape : :obj:`tuple`
623-
Operator shape
623+
Operator shape.
624624
625625
Raises
626626
------

pylops/basicoperators/block.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,12 @@ class Block(_Block):
7272
7373
Attributes
7474
----------
75+
pool : :obj:`multiprocessing.Pool` or :obj:`None`
76+
Pool of workers used to evaluate the N operators in parallel using
77+
``multiprocessing``. When ``nproc=1``, no pool is created (i.e.,
78+
``pool=None``).
7579
shape : :obj:`tuple`
76-
Operator shape
80+
Operator shape.
7781
7882
Notes
7983
-----

pylops/basicoperators/blockdiag.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ class BlockDiag(LinearOperator):
8080
``multiprocessing``. When ``nproc=1``, no pool is created (i.e.,
8181
``pool=None``).
8282
shape : :obj:`tuple`
83-
Operator shape
83+
Operator shape.
8484
8585
Notes
8686
-----

pylops/basicoperators/causalintegration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class CausalIntegration(LinearOperator):
4747
4848
For example, ``y_reshaped = (Op * x.ravel()).reshape(Op.dimsd)``.
4949
shape : :obj:`tuple`
50-
Operator shape
50+
Operator shape.
5151
5252
Notes
5353
-----

pylops/basicoperators/conj.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class Conj(LinearOperator):
3636
Shape of the array after the forward, but before flattening. In
3737
this case, same as ``dims``.
3838
shape : :obj:`tuple`
39-
Operator shape
39+
Operator shape.
4040
4141
Notes
4242
-----

pylops/basicoperators/diagonal.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class Diagonal(LinearOperator):
5353
Vector to be used for element-wise multiplication has complex numbers
5454
(``True``) or not (``False``).
5555
shape : :obj:`tuple`
56-
Operator shape
56+
Operator shape.
5757
5858
Notes
5959
-----

pylops/basicoperators/directionalderivative.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,7 @@ class FirstDirectionalDerivative(LinearOperator):
4646
4747
For example, ``y_reshaped = (Op * x.ravel()).reshape(Op.dimsd)``.
4848
shape : :obj:`tuple`
49-
Operator shape
50-
explicit : :obj:`bool`
51-
Operator contains a matrix that can be solved explicitly
52-
(``True``) or not (``False``).
49+
Operator shape.
5350
5451
Notes
5552
-----
@@ -155,7 +152,7 @@ class SecondDirectionalDerivative(LinearOperator):
155152
156153
For example, ``y_reshaped = (Op * x.ravel()).reshape(Op.dimsd)``.
157154
shape : :obj:`tuple`
158-
Operator shape
155+
Operator shape.
159156
160157
Notes
161158
-----

pylops/basicoperators/firstderivative.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class FirstDerivative(LinearOperator):
3737
edge : :obj:`bool`, optional
3838
Use reduced order derivative at edges (``True``) or
3939
ignore them (``False``). This is currently only available
40-
for centered derivative
40+
for centered derivative
4141
order : :obj:`int`, optional
4242
.. versionadded:: 2.0.0
4343
@@ -60,7 +60,7 @@ class FirstDerivative(LinearOperator):
6060
Shape of the array after the forward, but before flattening. In
6161
this case, same as ``dims``.
6262
shape : :obj:`tuple`
63-
Operator shape
63+
Operator shape.
6464
6565
Notes
6666
-----

pylops/basicoperators/flip.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class Flip(LinearOperator):
4040
Shape of the array after the forward, but before flattening. In
4141
this case, same as ``dims``.
4242
shape : :obj:`tuple`
43-
Operator shape
43+
Operator shape.
4444
4545
Notes
4646
-----

pylops/basicoperators/functionoperator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class FunctionOperator(LinearOperator):
4848
Attributes
4949
----------
5050
shape : :obj:`tuple`
51-
Operator shape :math:`[n \times m]`
51+
Operator shape. :math:`[n \times m]`
5252
5353
Examples
5454
--------

0 commit comments

Comments
 (0)