minor changes

Author: NimaSarajpoor

stumpy/core.py

@@ -557,9 +557,9 @@ def get_max_window_size(n):
 def check_window_size(m, max_size=None, n=None):
     """
     Check the window size and ensure that it is greater than or equal to 3 and, if
-    `max_size` is provided, ensure that the window size is less than or equal to the
-    `max_size`. Furthermore, if `n` is provided, then a self-join is assumed and it
-    checks whether all subsequences have at least one non-trivial neighbor.
+    ``max_size`` is provided, ensure that the window size is less than or equal to
+    the ``max_size``. Furthermore, if ``n`` is provided, then a self-join is assumed
+    and it checks whether all subsequences have at least one non-trivial neighbor.
 
     Parameters
     ----------
@@ -571,7 +571,7 @@ def check_window_size(m, max_size=None, n=None):
 
     n : int, default None
         The length of the time series in the case of a self-join.
-        `n` should be set to `None` in the case of an `AB-join`.
+        ``n`` should not be supplied (or set to ``None``) in the case of an AB-join.
 
     Returns
     -------

stumpy/mstump.py

@@ -1228,8 +1228,8 @@ def mstump(
         err = f"T is {T_A.ndim}-dimensional and must be at least 1-dimensional"
         raise ValueError(f"{err}")
 
-    # mstump currently supports self-join. Therefore, the argument `n=T_A.shape[1]`
-    # should be passed to the function `core.check_window_size`.
+    # mstump currently only supports self-join. Therefore, the argument `n=T_A.shape[1]`
+    # must be passed to the function `core.check_window_size`.
     core.check_window_size(m, max_size=min(T_A.shape[1], T_B.shape[1]), n=T_A.shape[1])
 
     if include is not None:

stumpy/mstumped.py

@@ -505,8 +505,8 @@ def mstumped(
         err = f"T is {T_A.ndim}-dimensional and must be at least 1-dimensional"
         raise ValueError(f"{err}")
 
-    # mstump currently supports self-join. Therefore, the argument `n` should be
-    # passed to the function `core.check_window_size`.
+    # mstump currently only supports self-join. Therefore, the argument `n=T_A.shape[1]`
+    # must be passed to the function `core.check_window_size`.
     core.check_window_size(m, max_size=min(T_A.shape[1], T_B.shape[1]), n=T_A.shape[1])
 
     if include is not None: