diff options
author | Fred Drake <fdrake@acm.org> | 2001-02-22 21:25:20 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2001-02-22 21:25:20 (GMT) |
commit | 7c30de65f4886629288564d8345e4aadb58d68df (patch) | |
tree | dd9dbc231d6d3f56985fe198844d8efb7e488831 /Doc | |
parent | 1c8e1f0654f26765c89753bede75be9f3132e11e (diff) | |
download | cpython-7c30de65f4886629288564d8345e4aadb58d68df.zip cpython-7c30de65f4886629288564d8345e4aadb58d68df.tar.gz cpython-7c30de65f4886629288564d8345e4aadb58d68df.tar.bz2 |
Remove documentation for the soundex module; the module is no longer
included with Python.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/lib/lib.tex | 65 | ||||
-rw-r--r-- | Doc/lib/libsoundex.tex | 43 |
2 files changed, 32 insertions, 76 deletions
diff --git a/Doc/lib/lib.tex b/Doc/lib/lib.tex index 5dde036..ca75615 100644 --- a/Doc/lib/lib.tex +++ b/Doc/lib/lib.tex @@ -8,9 +8,9 @@ \input{boilerplate} -\makeindex % tell \index to actually write the - % .idx file -\makemodindex % ... and the module index as well. +\makeindex % tell \index to actually write the + % .idx file +\makemodindex % ... and the module index as well. \begin{document} @@ -62,16 +62,16 @@ and how to embed it in other applications. \tableofcontents - % Chapter title: + % Chapter title: -\input{libintro} % Introduction +\input{libintro} % Introduction -\input{libobjs} % Built-in Types, Exceptions and Functions +\input{libobjs} % Built-in Types, Exceptions and Functions \input{libstdtypes} \input{libexcs} \input{libfuncs} -\input{libpython} % Python Runtime Services +\input{libpython} % Python Runtime Services \input{libsys} \input{libgc} \input{libweakref} @@ -83,7 +83,7 @@ and how to embed it in other applications. \input{libtraceback} \input{liblinecache} \input{libpickle} -\input{libcopyreg} % really copy_reg +\input{libcopyreg} % really copy_reg \input{libshelve} \input{libcopy} \input{libmarshal} @@ -96,10 +96,10 @@ and how to embed it in other applications. \input{libnew} \input{libsite} \input{libuser} -\input{libbltin} % really __builtin__ -\input{libmain} % really __main__ +\input{libbltin} % really __builtin__ +\input{libmain} % really __main__ -\input{libstrings} % String Services +\input{libstrings} % String Services \input{libstring} \input{libre} \input{libstruct} @@ -109,7 +109,7 @@ and how to embed it in other applications. \input{libcodecs} \input{libunicodedata} -\input{libmisc} % Miscellaneous Services +\input{libmisc} % Miscellaneous Services \input{libdoctest} \input{libmath} \input{libcmath} @@ -124,9 +124,9 @@ and how to embed it in other applications. \input{libcmd} \input{libshlex} -\input{liballos} % Generic Operating System Services +\input{liballos} % Generic Operating System Services \input{libos} -\input{libposixpath} % os.path +\input{libposixpath} % os.path \input{libdircache} \input{libstat} \input{libstatcache} @@ -138,7 +138,7 @@ and how to embed it in other applications. \input{libmutex} \input{libgetpass} \input{libcurses} -\input{libascii} % curses.ascii +\input{libascii} % curses.ascii \input{libgetopt} \input{libtempfile} \input{liberrno} @@ -148,7 +148,7 @@ and how to embed it in other applications. \input{liblocale} \input{libgettext} -\input{libsomeos} % Optional Operating System Services +\input{libsomeos} % Optional Operating System Services \input{libsignal} \input{libsocket} \input{libselect} @@ -166,7 +166,7 @@ and how to embed it in other applications. \input{libreadline} \input{librlcompleter} -\input{libunix} % UNIX Specific Services +\input{libunix} % UNIX Specific Services \input{libposix} \input{libpwd} \input{libgrp} @@ -185,11 +185,11 @@ and how to embed it in other applications. \input{libsyslog} \input{libcommands} -\input{libpdb} % The Python Debugger +\input{libpdb} % The Python Debugger -\input{libprofile} % The Python Profiler +\input{libprofile} % The Python Profiler -\input{internet} % Internet Protocols +\input{internet} % Internet Protocols \input{libwebbrowser} \input{libcgi} \input{liburllib} @@ -209,7 +209,7 @@ and how to embed it in other applications. \input{libcookie} \input{libasyncore} -\input{netdata} % Internet Data Handling +\input{netdata} % Internet Data Handling \input{libformatter} \input{librfc822} \input{libmimetools} @@ -242,7 +242,7 @@ and how to embed it in other applications. \input{xmlsaxreader} \input{libxmllib} -\input{libmm} % Multimedia Services +\input{libmm} % Multimedia Services \input{libaudioop} \input{libimageop} \input{libaifc} @@ -254,7 +254,7 @@ and how to embed it in other applications. \input{libimghdr} \input{libsndhdr} -\input{libcrypto} % Cryptographic Services +\input{libcrypto} % Cryptographic Services \input{libmd5} \input{libsha} \input{libmpz} @@ -264,7 +264,7 @@ and how to embed it in other applications. \input{librexec} \input{libbastion} -\input{language} % Python Language Services +\input{language} % Python Language Services \input{libparser} \input{libsymbol} \input{libtoken} @@ -272,15 +272,15 @@ and how to embed it in other applications. \input{libtokenize} \input{libtabnanny} \input{libpyclbr} -\input{libpycompile} % really py_compile +\input{libpycompile} % really py_compile \input{libcompileall} \input{libdis} -%\input{libamoeba} % AMOEBA ONLY +%\input{libamoeba} % AMOEBA ONLY -%\input{libstdwin} % STDWIN ONLY +%\input{libstdwin} % STDWIN ONLY -\input{libsgi} % SGI IRIX ONLY +\input{libsgi} % SGI IRIX ONLY \input{libal} \input{libcd} \input{libfl} @@ -290,10 +290,10 @@ and how to embed it in other applications. \input{libjpeg} %\input{libpanel} -\input{libsun} % SUNOS ONLY +\input{libsun} % SUNOS ONLY \input{libsunaudio} -\input{windows} % MS Windows ONLY +\input{windows} % MS Windows ONLY \input{libmsvcrt} \input{libwinreg} \input{libwinsound} @@ -308,7 +308,6 @@ and how to embed it in other applications. %\input{librand} %\input{libregex} %\input{libregsub} -%\input{libsoundex} \chapter{Reporting Bugs} \input{reportingbugs} @@ -322,11 +321,11 @@ and how to embed it in other applications. %begin{latexonly} \renewcommand{\indexname}{Module Index} %end{latexonly} -\input{modlib.ind} % Module Index +\input{modlib.ind} % Module Index %begin{latexonly} \renewcommand{\indexname}{Index} %end{latexonly} -\input{lib.ind} % Index +\input{lib.ind} % Index \end{document} diff --git a/Doc/lib/libsoundex.tex b/Doc/lib/libsoundex.tex deleted file mode 100644 index 25e82cf..0000000 --- a/Doc/lib/libsoundex.tex +++ /dev/null @@ -1,43 +0,0 @@ -\section{\module{soundex} --- - None} -\declaremodule{builtin}{soundex} - -\modulesynopsis{None} - - - -The soundex algorithm takes an English word, and returns an -easily-computed hash of it; this hash is intended to be the same for -words that sound alike. This module provides an interface to the -soundex algorithm. - -Note that the soundex algorithm is quite simple-minded, and isn't -perfect by any measure. Its main purpose is to help looking up names -in databases, when the name may be misspelled --- soundex hashes common -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. (Note -that the original algorithm produces a 4-character result.) -\end{funcdesc} - -\begin{funcdesc}{sound_similar}{string1, string2} -Compare the word in \var{string1} with the word in \var{string2}; this -is equivalent to -\code{get_soundex(\var{string1})} \code{==} -\code{get_soundex(\var{string2})}. -\end{funcdesc} - - -\begin{seealso} - \seetext{Donald E. Knuth, \citetitle{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} |