Add ~ to show only the function name

steff456 · steff456 · commit 9c475eb94743 · 2022-01-31T13:22:06.000-05:00
diff --git a/spec/API_specification/signatures/array_object.py b/spec/API_specification/signatures/array_object.py
@@ -133,7 +133,7 @@ def __abs__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.abs`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.abs`.
         """
 
     def __add__(self: array, other: Union[int, float, array], /) -> array:
@@ -179,7 +179,7 @@ def __add__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.add`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.add`.
         """
 
     def __and__(self: array, other: Union[int, bool, array], /) -> array:
@@ -200,7 +200,7 @@ def __and__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.bitwise_and`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_and`.
         """
 
     def __array_namespace__(self: array, /, *, api_version: Optional[str] = None) -> Any:
@@ -237,7 +237,7 @@ def __bool__(self: array, /) -> bool:
 
     def __dlpack__(self: array, /, *, stream: Optional[Union[int, Any]] = None) -> PyCapsule:
         """
-        Exports the array for consumption by :func:`signatures.creation_functions.from_dlpack` as a DLPack capsule.
+        Exports the array for consumption by :func:`~signatures.creation_functions.from_dlpack` as a DLPack capsule.
 
         Parameters
         ----------
@@ -292,7 +292,7 @@ def __dlpack__(self: array, /, *, stream: Optional[Union[int, Any]] = None) -> P
 
     def __dlpack_device__(self: array, /) -> Tuple[Enum, int]:
         """
-        Returns device type and device ID in DLPack format. Meant for use within :func:`signatures.creation_functions.from_dlpack`.
+        Returns device type and device ID in DLPack format. Meant for use within :func:`~signatures.creation_functions.from_dlpack`.
 
         Parameters
         ----------
@@ -334,7 +334,7 @@ def __eq__(self: array, other: Union[int, float, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.equal`.
         """
 
     def __float__(self: array, /) -> float:
@@ -409,7 +409,7 @@ def __floordiv__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.floor_divide`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.floor_divide`.
         """
 
     def __ge__(self: array, other: Union[int, float, array], /) -> array:
@@ -430,7 +430,7 @@ def __ge__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.greater_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.greater_equal`.
         """
 
     def __getitem__(self: array, key: Union[int, slice, ellipsis, Tuple[Union[int, slice, ellipsis], ...], array], /) -> array:
@@ -468,7 +468,7 @@ def __gt__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.greater`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.greater`.
         """
 
     def __index__(self: array, /) -> int:
@@ -520,7 +520,7 @@ def __invert__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.bitwise_invert`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_invert`.
         """
 
     def __le__(self: array, other: Union[int, float, array], /) -> array:
@@ -541,7 +541,7 @@ def __le__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.less_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.less_equal`.
         """
 
     def __lshift__(self: array, other: Union[int, array], /) -> array:
@@ -562,7 +562,7 @@ def __lshift__(self: array, other: Union[int, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.bitwise_left_shift`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_left_shift`.
         """
 
     def __lt__(self: array, other: Union[int, float, array], /) -> array:
@@ -583,7 +583,7 @@ def __lt__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.less`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.less`.
         """
 
     def __matmul__(self: array, other: array, /) -> array:
@@ -614,7 +614,7 @@ def __matmul__(self: array, other: array, /) -> array:
 
 
         .. note::
-           Results must equal the results returned by the equivalent function :func:`signatures.linear_algebra_functions.matmul`.
+           Results must equal the results returned by the equivalent function :func:`~signatures.linear_algebra_functions.matmul`.
 
         **Raises**
 
@@ -646,7 +646,7 @@ def __mod__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.remainder`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.remainder`.
         """
 
     def __mul__(self: array, other: Union[int, float, array], /) -> array:
@@ -685,7 +685,7 @@ def __mul__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.multiply`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.multiply`.
         """
 
     def __ne__(self: array, other: Union[int, float, bool, array], /) -> array:
@@ -706,7 +706,7 @@ def __ne__(self: array, other: Union[int, float, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.not_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.not_equal`.
         """
 
     def __neg__(self: array, /) -> array:
@@ -728,7 +728,7 @@ def __neg__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.negative`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.negative`.
         """
 
     def __or__(self: array, other: Union[int, bool, array], /) -> array:
@@ -749,7 +749,7 @@ def __or__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.bitwise_or`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_or`.
         """
 
     def __pos__(self: array, /) -> array:
@@ -768,7 +768,7 @@ def __pos__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.positive`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.positive`.
         """
 
     def __pow__(self: array, other: Union[int, float, array], /) -> array:
@@ -823,7 +823,7 @@ def __pow__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.pow`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.pow`.
         """
 
     def __rshift__(self: array, other: Union[int, array], /) -> array:
@@ -844,7 +844,7 @@ def __rshift__(self: array, other: Union[int, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.bitwise_right_shift`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_right_shift`.
         """
 
     def __setitem__(self: array, key: Union[int, slice, ellipsis, Tuple[Union[int, slice, ellipsis], ...], array], value: Union[int, float, bool, array], /) -> None:
@@ -888,7 +888,7 @@ def __sub__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.subtract`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.subtract`.
         """
 
     def __truediv__(self: array, other: Union[int, float, array], /) -> array:
@@ -941,7 +941,7 @@ def __truediv__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.divide`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.divide`.
         """
 
     def __xor__(self: array, other: Union[int, bool, array], /) -> array:
@@ -962,7 +962,7 @@ def __xor__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`signatures.elementwise_functions.bitwise_xor`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_xor`.
         """
 
     def to_device(self: array, device: Device, /, *, stream: Optional[Union[int, Any]] = None) -> array:
diff --git a/spec/API_specification/signatures/extension_linear_algebra_functions.py b/spec/API_specification/signatures/extension_linear_algebra_functions.py
@@ -158,7 +158,7 @@ def inv(x: array, /) -> array:
 
 def matmul(x1: array, x2: array, /) -> array:
     """
-    Alias for :func:`signatures.linear_algebra_functions.matmul`.
+    Alias for :func:`~signatures.linear_algebra_functions.matmul`.
     """
 
 def matrix_norm(x: array, /, *, keepdims: bool = False, ord: Optional[Union[int, float, Literal[inf, -inf, 'fro', 'nuc']]] = 'fro') -> array:
@@ -250,7 +250,7 @@ def matrix_rank(x: array, /, *, rtol: Optional[Union[float, array]] = None) -> a
 
 def matrix_transpose(x: array, /) -> array:
     """
-    Alias for :func:`signatures.linear_algebra_functions.matrix_transpose`.
+    Alias for :func:`~signatures.linear_algebra_functions.matrix_transpose`.
     """
 
 def outer(x1: array, x2: array, /) -> array:
@@ -407,7 +407,7 @@ def svdvals(x: array, /) -> array:
 
 def tensordot(x1: array, x2: array, /, *, axes: Union[int, Tuple[Sequence[int], Sequence[int]]] = 2) -> array:
     """
-    Alias for :func:`signatures.linear_algebra_functions.tensordot`.
+    Alias for :func:`~signatures.linear_algebra_functions.tensordot`.
     """
 
 def trace(x: array, /, *, offset: int = 0) -> array:
@@ -441,7 +441,7 @@ def trace(x: array, /, *, offset: int = 0) -> array:
 
 def vecdot(x1: array, x2: array, /, *, axis: int = None) -> array:
     """
-    Alias for :func:`signatures.linear_algebra_functions.vecdot`.
+    Alias for :func:`~signatures.linear_algebra_functions.vecdot`.
     """
 
 def vector_norm(x: array, /, *, axis: Optional[Union[int, Tuple[int, ...]]] = None, keepdims: bool = False, ord: Union[int, float, Literal[inf, -inf]] = 2) -> array:
