]> granicus.if.org Git - python/commitdiff
read() method: clarify that strings are accepted and interpreted
authorFred Drake <fdrake@acm.org>
Tue, 9 May 2000 15:06:32 +0000 (15:06 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 9 May 2000 15:06:32 +0000 (15:06 +0000)
        reasonably.

readfp() method:  added documentation.

Doc/lib/libcfgparser.tex

index 50af056bdd71b7ade88fb69394261ee11bc0e28d..6b09af8a787bfae22a9130b80d3248acdff1ad36 100644 (file)
@@ -114,7 +114,15 @@ Returns a list of options available in the specified \var{section}.
 \end{methoddesc}
 
 \begin{methoddesc}{read}{filenames}
-Read and parse a list of filenames.
+Read and parse a list of filenames.  If \var{filenames} is a string or
+Unicode string, it is treated as a single filename.
+\end{methoddesc}
+
+\begin{methoddesc}{readfp}{fp\optional{, filename}}
+Read and parse configuration data from the file or file-like object in
+\var{fp} (only the \method{readline()} method is used).  If
+\var{filename} is omitted and \var{fp} has a \member{name} attribute,
+that is used for \var{filename}; the default is \samp{<???>}.
 \end{methoddesc}
 
 \begin{methoddesc}{get}{section, option\optional{, raw\optional{, vars}}}