summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libcfgparser.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-05-09 15:06:32 (GMT)
committerFred Drake <fdrake@acm.org>2000-05-09 15:06:32 (GMT)
commitd85f05940e00e1e2b9665016c99100f5bebcd1ea (patch)
tree45aaa840df1d3aa5607c3415d9351e87cfd54e8f /Doc/lib/libcfgparser.tex
parent57af072e5c0dcacf5c7fe3789113c21d223e1258 (diff)
downloadcpython-d85f05940e00e1e2b9665016c99100f5bebcd1ea.zip
cpython-d85f05940e00e1e2b9665016c99100f5bebcd1ea.tar.gz
cpython-d85f05940e00e1e2b9665016c99100f5bebcd1ea.tar.bz2
read() method: clarify that strings are accepted and interpreted
reasonably. readfp() method: added documentation.
Diffstat (limited to 'Doc/lib/libcfgparser.tex')
-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 50af056..6b09af8 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}}}