From: Fred Drake <fdrake@acm.org>
Date: Tue, 7 Apr 1998 19:58:19 +0000 (+0000)
Subject: Added a reference to the discussion in Knuth's "Sorting and Searching", and
X-Git-Tag: v1.5.1~155
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c708605f4f8a8f982ea7a99a517ae03c2fb6bb2d;p=python

Added a reference to the discussion in Knuth's "Sorting and Searching", and
noted that the original algorithm produces 4-character results rather than
the 6-character results provided by this module.
---

diff --git a/Doc/lib/libsoundex.tex b/Doc/lib/libsoundex.tex
index 7d483ed2a2..fdecbab102 100644
--- a/Doc/lib/libsoundex.tex
+++ b/Doc/lib/libsoundex.tex
@@ -16,7 +16,8 @@ misspellings together.
 \begin{funcdesc}{get_soundex}{string}
 Return the soundex hash value for a word; it will always be a
 6-character string.  \var{string} must contain the word to be hashed,
-with no leading whitespace; the case of the word is ignored.
+with no leading whitespace; the case of the word is ignored.  (Note
+that the original algorithm produces a 4-character result.)
 \end{funcdesc}
 
 \begin{funcdesc}{sound_similar}{string1, string2}
@@ -25,3 +26,16 @@ is equivalent to
 \code{get_soundex(\var{string1})} \code{==}
 \code{get_soundex(\var{string2})}.
 \end{funcdesc}
+
+
+\begin{seealso}
+
+\seetext{Donald E. Knuth, \emph{Sorting and Searching,} vol. 3 in
+``The Art of Computer Programming.'' Addison-Wesley Publishing
+Company:  Reading, MA: 1973. pp.\ 391-392.  Discusses the origin and
+usefulness of the algorithm, as well as the algorithm itself.  Knuth
+gives his sources as \emph{U.S. Patents 1261167} (1918) and
+\emph{1435663} (1922), attributing the algorithm to Margaret K. Odell
+and Robert C. Russel.  Additional references are provided.}
+
+\end{seealso}
diff --git a/Doc/libsoundex.tex b/Doc/libsoundex.tex
index 7d483ed2a2..fdecbab102 100644
--- a/Doc/libsoundex.tex
+++ b/Doc/libsoundex.tex
@@ -16,7 +16,8 @@ misspellings together.
 \begin{funcdesc}{get_soundex}{string}
 Return the soundex hash value for a word; it will always be a
 6-character string.  \var{string} must contain the word to be hashed,
-with no leading whitespace; the case of the word is ignored.
+with no leading whitespace; the case of the word is ignored.  (Note
+that the original algorithm produces a 4-character result.)
 \end{funcdesc}
 
 \begin{funcdesc}{sound_similar}{string1, string2}
@@ -25,3 +26,16 @@ is equivalent to
 \code{get_soundex(\var{string1})} \code{==}
 \code{get_soundex(\var{string2})}.
 \end{funcdesc}
+
+
+\begin{seealso}
+
+\seetext{Donald E. Knuth, \emph{Sorting and Searching,} vol. 3 in
+``The Art of Computer Programming.'' Addison-Wesley Publishing
+Company:  Reading, MA: 1973. pp.\ 391-392.  Discusses the origin and
+usefulness of the algorithm, as well as the algorithm itself.  Knuth
+gives his sources as \emph{U.S. Patents 1261167} (1918) and
+\emph{1435663} (1922), attributing the algorithm to Margaret K. Odell
+and Robert C. Russel.  Additional references are provided.}
+
+\end{seealso}