Skip to content

Commit 6c57fc3

Browse files
committed
minor: added versionadded to docstrings
1 parent 3066a4f commit 6c57fc3

File tree

5 files changed

+10
-0
lines changed

5 files changed

+10
-0
lines changed

pylops/signalprocessing/patch2d.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ class Patch2D(LinearOperator):
142142
tapertype : :obj:`str`, optional
143143
Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
144144
savetaper: :obj:`bool`, optional
145+
.. versionadded:: 2.3.0
146+
145147
Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
146148
The first option is more computationally efficient, whilst the second is more memory efficient.
147149
scalings : :obj:`tuple` or :obj:`list`, optional

pylops/signalprocessing/patch3d.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,8 @@ class Patch3D(LinearOperator):
157157
tapertype : :obj:`str`, optional
158158
Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
159159
savetaper: :obj:`bool`, optional
160+
.. versionadded:: 2.3.0
161+
160162
Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
161163
The first option is more computationally efficient, whilst the second is more memory efficient.
162164
scalings : :obj:`tuple` or :obj:`list`, optional

pylops/signalprocessing/sliding1d.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ class Sliding1D(LinearOperator):
128128
tapertype : :obj:`str`, optional
129129
Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
130130
savetaper: :obj:`bool`, optional
131+
.. versionadded:: 2.3.0
132+
131133
Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
132134
The first option is more computationally efficient, whilst the second is more memory efficient.
133135
name : :obj:`str`, optional

pylops/signalprocessing/sliding2d.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,8 @@ class Sliding2D(LinearOperator):
164164
tapertype : :obj:`str`, optional
165165
Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
166166
savetaper: :obj:`bool`, optional
167+
.. versionadded:: 2.3.0
168+
167169
Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
168170
The first option is more computationally efficient, whilst the second is more memory efficient.
169171
name : :obj:`str`, optional

pylops/signalprocessing/sliding3d.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@ class Sliding3D(LinearOperator):
150150
tapertype : :obj:`str`, optional
151151
Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
152152
savetaper: :obj:`bool`, optional
153+
.. versionadded:: 2.3.0
154+
153155
Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
154156
The first option is more computationally efficient, whilst the second is more memory efficient.
155157
nproc : :obj:`int`, optional

0 commit comments

Comments
 (0)