docs: Add versionadded to new tensorlib methods (#2025)

* Add versionadded sphinx directive to transpose and percentile tensorlib methods.
scikit-hep · Sep 23, 2022 · c2710e9 · c2710e9
1 parent 67c0b58
commit c2710e9
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/src/pyhf/tensor/jax_backend.py b/src/pyhf/tensor/jax_backend.py
@@ -319,6 +319,7 @@ def percentile(self, tensor_in, q, axis=None, interpolation="linear"):
         Returns:
             JAX ndarray: The value of the :math:`q`-th percentile of the tensor along the specified axis.
 
+        .. versionadded:: 0.7.0
         """
         return jnp.percentile(tensor_in, q, axis=axis, interpolation=interpolation)
 
@@ -618,5 +619,6 @@ def transpose(self, tensor_in):
         Returns:
             JAX ndarray: The transpose of the input tensor.
 
+        .. versionadded:: 0.7.0
         """
         return tensor_in.transpose()
diff --git a/src/pyhf/tensor/numpy_backend.py b/src/pyhf/tensor/numpy_backend.py
@@ -335,6 +335,7 @@ def percentile(
         Returns:
             NumPy ndarray: The value of the :math:`q`-th percentile of the tensor along the specified axis.
 
+        .. versionadded:: 0.7.0
         """
         # see https://github.com/numpy/numpy/issues/22125
         return np.percentile(tensor_in, q, axis=axis, interpolation=interpolation)  # type: ignore[call-overload,no-any-return]
@@ -637,5 +638,6 @@ def transpose(self, tensor_in: Tensor[T]) -> ArrayLike:
         Returns:
             :class:`numpy.ndarray`: The transpose of the input tensor.
 
+        .. versionadded:: 0.7.0
         """
         return tensor_in.transpose()
diff --git a/src/pyhf/tensor/pytorch_backend.py b/src/pyhf/tensor/pytorch_backend.py
@@ -325,6 +325,7 @@ def percentile(self, tensor_in, q, axis=None, interpolation="linear"):
         Returns:
             PyTorch tensor: The value of the :math:`q`-th percentile of the tensor along the specified axis.
 
+        .. versionadded:: 0.7.0
         """
         # Interpolation options not yet supported
         # c.f. https://github.com/pytorch/pytorch/pull/49267
@@ -621,5 +622,6 @@ def transpose(self, tensor_in):
         Returns:
             PyTorch FloatTensor: The transpose of the input tensor.
 
+        .. versionadded:: 0.7.0
         """
         return tensor_in.transpose(0, 1)
diff --git a/src/pyhf/tensor/tensorflow_backend.py b/src/pyhf/tensor/tensorflow_backend.py
@@ -346,6 +346,7 @@ def percentile(self, tensor_in, q, axis=None, interpolation="linear"):
         Returns:
             TensorFlow Tensor: The value of the :math:`q`-th percentile of the tensor along the specified axis.
 
+        .. versionadded:: 0.7.0
         """
         return tfp.stats.percentile(
             tensor_in, q, axis=axis, interpolation=interpolation
@@ -718,5 +719,6 @@ def transpose(self, tensor_in):
         Returns:
             TensorFlow Tensor: The transpose of the input tensor.
 
+        .. versionadded:: 0.7.0
         """
         return tf.transpose(tensor_in)