Merge pull request #316 from stephenhky/readthedocs

Documentation for Demarau-Levenshtein distance and longest common prefix

Author: stephenhky

shorttext/metrics/dynprog/dldist.py

@@ -4,7 +4,16 @@
 
 
 @nb.njit
-def damerau_levenshtein(word1, word2):
+def damerau_levenshtein(word1: str, word2: str) -> int:
+    """ Calculate the Demarau-Levenshtein (DL) distance between two words.
+
+    :param word1: first word
+    :param word2: seccond word
+    :return: Damerau-Levenshtein (DL) distance
+    :type word1: str
+    :type word2: str
+    :rtype: int
+    """
     len1 = len(word1)
     len2 = len(word2)
     matrix = np.zeros((len1+1, len2+1), dtype=np.int8)

shorttext/metrics/dynprog/lcp.py

@@ -4,6 +4,15 @@
 
 @nb.njit
 def longest_common_prefix(word1: str, word2: str) -> int:
+    """ Calculate the longest common prefix (LCP) between two words.
+
+    :param word1: first word
+    :param word2: seccond word
+    :return: longest common prefix (LCP)
+    :type word1: str
+    :type word2: str
+    :rtype: int
+    """
     lcp = 0
     for i in range(min(len(word1), len(word2))):
         if word1[i] == word2[i]: