Update documentation of cpdist

thomasryde · Apr 7, 2024 · a1ab6e3 · a1ab6e3
1 parent 8ea9723
commit a1ab6e3
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/docs/Usage/process.rst b/docs/Usage/process.rst
@@ -5,6 +5,10 @@ cdist
 ----------
 .. autofunction:: rapidfuzz.process.cdist
 
+cpdist
+----------
+.. autofunction:: rapidfuzz.process.cpdist
+
 extract
 -------
 .. autofunction:: rapidfuzz.process.extract

diff --git a/extern/rapidfuzz-cpp b/extern/rapidfuzz-cpp
diff --git a/src/rapidfuzz/process_py.py b/src/rapidfuzz/process_py.py
@@ -686,7 +686,7 @@ def cpdist(
     scorer_kwargs: dict[str, Any] | None = None,
 ) -> np.ndarray:
     """
-    Compute pairwise distance/similarity between corresponding elements in the two collection of inputs.
+    Compute pairwise distance/similarity between corresponding elements of the two input lists of strings.
 
     Parameters
     ----------
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,10 @@ cdist @@
     ----------
     .. autofunction:: rapidfuzz.process.cdist
+    cpdist
+    ----------
+    .. autofunction:: rapidfuzz.process.cpdist
     extract
     -------
     .. autofunction:: rapidfuzz.process.extract
@@ Expand Down @@
+0 −8		CHANGELOG.md
+1 −1		CMakeLists.txt
+3 −10		extras/rapidfuzz_amalgamated.hpp
+1 −1		rapidfuzz/details/GrowingHashmap.hpp
+5 −3		rapidfuzz/details/Range.hpp
+5 −5		rapidfuzz/distance/Indel.hpp
+2 −2		rapidfuzz/distance/Indel_impl.hpp
+0 −1		rapidfuzz/distance/JaroWinkler.hpp
+2 −8		rapidfuzz/distance/JaroWinkler_impl.hpp
+2 −3		rapidfuzz/distance/Jaro_impl.hpp
+6 −5		rapidfuzz/distance/LCSseq.hpp
+2 −2		rapidfuzz/distance/LCSseq_impl.hpp
+23 −17		rapidfuzz/distance/Levenshtein.hpp
+22 −16		rapidfuzz/distance/Levenshtein_impl.hpp
+8 −4		rapidfuzz/distance/OSA.hpp