minor: added versionadded to docstrings

PyLops · May 18, 2024 · 6c57fc3 · 6c57fc3
1 parent 3066a4f
commit 6c57fc3
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/pylops/signalprocessing/patch2d.py b/pylops/signalprocessing/patch2d.py
@@ -142,6 +142,8 @@ class Patch2D(LinearOperator):
     tapertype : :obj:`str`, optional
         Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
     savetaper: :obj:`bool`, optional
+        .. versionadded:: 2.3.0
+
         Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
         The first option is more computationally efficient, whilst the second is more memory efficient.
     scalings : :obj:`tuple` or :obj:`list`, optional

diff --git a/pylops/signalprocessing/patch3d.py b/pylops/signalprocessing/patch3d.py
@@ -157,6 +157,8 @@ class Patch3D(LinearOperator):
     tapertype : :obj:`str`, optional
         Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
     savetaper: :obj:`bool`, optional
+        .. versionadded:: 2.3.0
+
         Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
         The first option is more computationally efficient, whilst the second is more memory efficient.
     scalings : :obj:`tuple` or :obj:`list`, optional

diff --git a/pylops/signalprocessing/sliding1d.py b/pylops/signalprocessing/sliding1d.py
@@ -128,6 +128,8 @@ class Sliding1D(LinearOperator):
     tapertype : :obj:`str`, optional
         Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
     savetaper: :obj:`bool`, optional
+        .. versionadded:: 2.3.0
+
         Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
         The first option is more computationally efficient, whilst the second is more memory efficient.
     name : :obj:`str`, optional

diff --git a/pylops/signalprocessing/sliding2d.py b/pylops/signalprocessing/sliding2d.py
@@ -164,6 +164,8 @@ class Sliding2D(LinearOperator):
     tapertype : :obj:`str`, optional
         Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
     savetaper: :obj:`bool`, optional
+        .. versionadded:: 2.3.0
+
         Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
         The first option is more computationally efficient, whilst the second is more memory efficient.
     name : :obj:`str`, optional

diff --git a/pylops/signalprocessing/sliding3d.py b/pylops/signalprocessing/sliding3d.py
@@ -150,6 +150,8 @@ class Sliding3D(LinearOperator):
     tapertype : :obj:`str`, optional
         Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``)
     savetaper: :obj:`bool`, optional
+        .. versionadded:: 2.3.0
+
         Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``).
         The first option is more computationally efficient, whilst the second is more memory efficient.
     nproc : :obj:`int`, optional