Commit 0ec3e0bd authored by Fred Drake's avatar Fred Drake

Small English usage nits.

parent cdeb3e80
\section{\module{linecache} --- \section{\module{linecache} ---
Treat files like lists of lines} Random access to text lines}
\declaremodule{standard}{linecache} \declaremodule{standard}{linecache}
\sectionauthor{Moshe Zadka}{mzadka@geocities.com} \sectionauthor{Moshe Zadka}{mzadka@geocities.com}
\modulesynopsis{This module treats files like random-access lists of lines.} \modulesynopsis{This module provides random access to individual lines
from text files.}
The \module{linecache} module allows one to get any line from any file, The \module{linecache} module allows one to get any line from any file,
while attempting to optimize internally, using a cache, the common case while attempting to optimize internally, using a cache, the common case
where many lines are read from a file. where many lines are read from a single file. This is used by the
\refmodule{traceback} module to retrieve source lines for inclusion in
the formatted traceback.
The \module{linecache} module defines the following functions: The \module{linecache} module defines the following functions:
...@@ -17,19 +20,19 @@ Get line \var{lineno} from file named \var{filename}. This function ...@@ -17,19 +20,19 @@ Get line \var{lineno} from file named \var{filename}. This function
will never throw an exception --- it will return \code{''} on errors. will never throw an exception --- it will return \code{''} on errors.
If a file named \var{filename} is not found, the function will look If a file named \var{filename} is not found, the function will look
for it in the module search path. for it in the module\indexiii{module}{search}{path} search path,
\code{sys.path}.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{clearcache}{} \begin{funcdesc}{clearcache}{}
Clear the cache. You might want to use this function if you know that Clear the cache. Use this function if you know that you do not need
you do not need to read lines from many of files you already read from to read lines from many of files you already read from using this
using this module. module.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{checkcache}{} \begin{funcdesc}{checkcache}{}
Check the cache is still valid. You might want to use this function if Check the cache for validity. Use this function if files in the cache
you suspect that files you read from using this module might have may have changed on disk, and you require the updated version.
changed.
\end{funcdesc} \end{funcdesc}
Example: Example:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment