[DOC] Fix inconsistent double backticks in similarity_search module (#809)

aeon/similarity_search/series/_commons.py

@@ -41,10 +41,10 @@ def fft_sliding_dot_product(X, q):
     Use FFT convolution to calculate the sliding window dot product.
 
     This function applies the Fast Fourier Transform (FFT) to efficiently compute
-    the sliding dot product between the input time series `X` and the query `q`.
+    the sliding dot product between the input time series ``X`` and the query ``q``.
     The dot product is computed for each channel individually. The sliding window
     approach ensures that the dot product is calculated for every possible subsequence
-    of `X` that matches the length of `q`
+    of ``X`` that matches the length of ``q``
 
     Parameters
     ----------

aeon/similarity_search/series/motifs/_stomp.py

@@ -157,8 +157,8 @@ def _predict(
             A factor of the query length used to define the exclusion zone when
             ``allow_trivial_matches`` is set to False. For a given timestamp,
             the exclusion zone starts from
-            :math:`id_timestamp - floor(length*exclusion_factor)` and end at
-            :math:`id_timestamp + floor(length*exclusion_factor)`.
+            :math:``id_timestamp - floor(length*exclusion_factor)`` and end at
+            :math:``id_timestamp + floor(length*exclusion_factor)``.
         inverse_distance : bool
             If True, the matching will be made on the inverse of the distance, and thus,
             the farther neighbors will be returned instead of the closest ones.
@@ -241,8 +241,8 @@ def compute_matrix_profile(
             A factor of the query length used to define the exclusion zone when
             ``allow_trivial_matches`` is set to False. For a given timestamp,
             the exclusion zone starts from
-            :math:`id_timestamp - floor(length * exclusion_factor)` and end at
-            :math:`id_timestamp + floor(length * exclusion_factor)`.
+            :math:``id_timestamp - floor(length * exclusion_factor)`` and end at
+            :math:``id_timestamp + floor(length * exclusion_factor)``.
         is_self_computation : bool
             Wheter X is equal to the series X_ given during fit.
 
@@ -317,7 +317,8 @@ def _get_test_params(cls, parameter_set: str = "default"):
         params : dict or list of dict, default = {}
             Parameters to create testing instances of the class
             Each dict are parameters to construct an "interesting" test instance, i.e.,
-            `MyClass(**params)` or `MyClass(**params[i])` creates a valid test instance.
+            ``MyClass(**params)`` or ``MyClass(**params[i])`` creates a valid test
+            instance.
         """
         if parameter_set == "default":
             params = {"length": 3}
@@ -375,9 +376,9 @@ def _stomp_normalized(
         The size of the exclusion zone used to prevent returning as top k candidates
         the ones that are close to each other (for example i and i+1).
         It is used to define a region between
-        :math:`id_timestamp - exclusion_size` and
-        :math:`id_timestamp + exclusion_size` which cannot be returned
-        as best match if :math:`id_timestamp` was already selected. By default,
+        :math:``id_timestamp - exclusion_size`` and
+        :math:``id_timestamp + exclusion_size`` which cannot be returned
+        as best match if :math:``id_timestamp`` was already selected. By default,
         the value None means that this is not used.
     inverse_distance : bool
         If True, the matching will be made on the inverse of the distance, and thus, the
@@ -470,9 +471,9 @@ def _stomp(
         The size of the exclusion zone used to prevent returning as top k candidates
         the ones that are close to each other (for example i and i+1).
         It is used to define a region between
-        :math:`id_timestamp - exclusion_size` and
-        :math:`id_timestamp + exclusion_size` which cannot be returned
-        as best match if :math:`id_timestamp` was already selected. By default,
+        :math:``id_timestamp - exclusion_size`` and
+        :math:``id_timestamp + exclusion_size`` which cannot be returned
+        as best match if :math:``id_timestamp`` was already selected. By default,
         the value None means that this is not used.
     inverse_distance : bool
         If True, the matching will be made on the inverse of the distance, and thus, the

aeon/similarity_search/series/neighbors/_dummy.py

@@ -81,8 +81,8 @@ def _predict(
             A factor of the query length used to define the exclusion zone when
             ``allow_neighboring_matches`` is set to False. For a given timestamp,
             the exclusion zone starts from
-            :math:`id_timestamp - floor(length * exclusion_factor)` and end at
-            :math:`id_timestamp + floor(length * exclusion_factor)`.
+            :math:``id_timestamp - floor(length * exclusion_factor)`` and end at
+            :math:``id_timestamp + floor(length * exclusion_factor)``.
         X_index : int, optional
             If ``X`` is a subsequence of X_, specify its starting timestamp in ``X_``.
             If specified, neighboring subsequences of X won't be able to match as
@@ -158,15 +158,16 @@ def _get_test_params(cls, parameter_set: str = "default"):
         ----------
         parameter_set : str, default="default"
             Name of the set of test parameters to return, for use in tests. If no
-            special parameters are defined for a value, will return `"default"` set.
+            special parameters are defined for a value, will return ``"default"`` set.
             There are currently no reserved values for transformers.
 
         Returns
         -------
         params : dict or list of dict, default = {}
             Parameters to create testing instances of the class
             Each dict are parameters to construct an "interesting" test instance, i.e.,
-            `MyClass(**params)` or `MyClass(**params[i])` creates a valid test instance.
+            ``MyClass(**params)`` or ``MyClass(**params[i])`` creates a valid test
+            instance.
         """
         if parameter_set == "default":
             params = {"length": 20}

aeon/similarity_search/series/neighbors/_mass.py

@@ -90,8 +90,8 @@ def _predict(
             A factor of the query length used to define the exclusion zone when
             ``allow_trivial_matches`` is set to False. For a given timestamp,
             the exclusion zone starts from
-            :math:`id_timestamp - floor(length * exclusion_factor)` and end at
-            :math:`id_timestamp + floor(length * exclusion_factor)`.
+            :math:``id_timestamp - floor(length * exclusion_factor)`` and end at
+            :math:``id_timestamp + floor(length * exclusion_factor)``.
         X_index : int, optional
             If ``X`` is a subsequence of X_, specify its starting timestamp in ``X_``.
             If specified, neighboring subsequences of X won't be able to match as
@@ -178,15 +178,16 @@ def _get_test_params(cls, parameter_set: str = "default"):
         ----------
         parameter_set : str, default="default"
             Name of the set of test parameters to return, for use in tests. If no
-            special parameters are defined for a value, will return `"default"` set.
+            special parameters are defined for a value, will return ``"default"`` set.
             There are currently no reserved values for transformers.
 
         Returns
         -------
         params : dict or list of dict, default = {}
             Parameters to create testing instances of the class
             Each dict are parameters to construct an "interesting" test instance, i.e.,
-            `MyClass(**params)` or `MyClass(**params[i])` creates a valid test instance.
+            ``MyClass(**params)`` or ``MyClass(**params[i])`` creates a valid test
+            instance.
         """
         if parameter_set == "default":
             params = {"length": 20}