Documented substring matching

Rapleaf · Jan 1, 2011 · 7f7ec77 · 7f7ec77
1 parent 22d1a46
commit 7f7ec77
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/RapMatcher.py b/RapMatcher.py
@@ -30,6 +30,10 @@ def __equality_match(self, word1, word2):
 		return word1 == word2
 
 	def __substring_match(self, word1, word2):
+		"""
+		Tests whether either word has length greater than 3
+		and is a substring of the other word
+		"""
 		return (((len(word1) > 3) and (word1 in word2)) or
 		((len(word2) > 3) and (word2 in word1)))