summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-05-09 15:06:32 +0000
committerFred Drake <fdrake@acm.org>2000-05-09 15:06:32 +0000
commit1df144a7d09899cffab931fe8c0950968d80c36f (patch)
treee55916b0a3bb5eff15084f04648e049e723cc00c /Doc
parentf0db9e10e42edc8d099adf84d76499750d71fcdb (diff)
downloadcpython-1df144a7d09899cffab931fe8c0950968d80c36f.tar.gz
read() method: clarify that strings are accepted and interpreted
reasonably. readfp() method: added documentation.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libcfgparser.tex10
1 files changed, 9 insertions, 1 deletions
diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex
index 50af056bdd..6b09af8a78 100644
--- a/Doc/lib/libcfgparser.tex
+++ b/Doc/lib/libcfgparser.tex
@@ -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}}}