diff options
| author | Ezio Melotti <ezio.melotti@gmail.com> | 2013-04-30 13:34:04 (GMT) |
|---|---|---|
| committer | Ezio Melotti <ezio.melotti@gmail.com> | 2013-04-30 13:34:04 (GMT) |
| commit | ab6ab15e7d4191fe8ea885262d48f880b591c7e8 (patch) | |
| tree | 3c1e167e9ae90cbb23058c7156026589ecd48406 | |
| parent | 5d6620d9d5c6e702846744036b50e25569e27fc5 (diff) | |
| download | cpython-ab6ab15e7d4191fe8ea885262d48f880b591c7e8.zip cpython-ab6ab15e7d4191fe8ea885262d48f880b591c7e8.tar.gz cpython-ab6ab15e7d4191fe8ea885262d48f880b591c7e8.tar.bz2 | |
#17881: clarify documentation of plistlib.
| -rw-r--r-- | Doc/library/plistlib.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index ae5e94d..a267368 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -47,8 +47,8 @@ This module defines the following functions: .. function:: readPlist(pathOrFile) - Read a plist file. *pathOrFile* may either be a file name or a (readable) - file object. Return the unpacked root object (which usually is a + Read a plist file. *pathOrFile* may either be a file name or a (readable and + binary) file object. Return the unpacked root object (which usually is a dictionary). The XML data is parsed using the Expat parser from :mod:`xml.parsers.expat` @@ -59,7 +59,7 @@ This module defines the following functions: .. function:: writePlist(rootObject, pathOrFile) Write *rootObject* to a plist file. *pathOrFile* may either be a file name - or a (writable) file object. + or a (writable and binary) file object. A :exc:`TypeError` will be raised if the object is of an unsupported type or a container that contains objects of unsupported types. |