diff options
| author | Jon Janzen <jjjonjanzen@gmail.com> | 2019-09-09 14:13:43 (GMT) |
|---|---|---|
| committer | Ronald Oussoren <ronaldoussoren@mac.com> | 2019-09-09 14:13:43 (GMT) |
| commit | 24b11b8c95e96cf9c93fb7fc253e6e96506f2d77 (patch) | |
| tree | a9d8f8d695e33f0edee7a437895ad036fd78e731 | |
| parent | c638521dbf8862d63151e4b984c9b586a954db4c (diff) | |
| download | cpython-24b11b8c95e96cf9c93fb7fc253e6e96506f2d77.zip cpython-24b11b8c95e96cf9c93fb7fc253e6e96506f2d77.tar.gz cpython-24b11b8c95e96cf9c93fb7fc253e6e96506f2d77.tar.bz2 | |
bpo-38053 Update documentation for plistlib (GH-15727)
* Update documentation for plistlib
- Update "Mac OS X" to "Apple" since plists are used more widely than just macOS
- Re-add the UID class documentation (oops, removed in GH-15615)
| -rw-r--r-- | Doc/library/plistlib.rst | 22 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2019-09-07-19-09-01.bpo-38053.lttibE.rst | 1 |
2 files changed, 19 insertions, 4 deletions
diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index f71aaa2..68320f1 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -1,8 +1,8 @@ -:mod:`plistlib` --- Generate and parse Mac OS X ``.plist`` files -================================================================ +:mod:`plistlib` --- Generate and parse Apple ``.plist`` files +============================================================= .. module:: plistlib - :synopsis: Generate and parse Mac OS X plist files. + :synopsis: Generate and parse Apple plist files. .. moduleauthor:: Jack Jansen .. sectionauthor:: Georg Brandl <georg@python.org> @@ -17,7 +17,8 @@ -------------- This module provides an interface for reading and writing the "property list" -files used mainly by Mac OS X and supports both binary and XML plist files. +files used by Apple, primarily on macOS and iOS. This module supports both binary +and XML plist files. The property list (``.plist``) file format is a simple serialization supporting basic object types, like dictionaries, lists, numbers and strings. Usually the @@ -124,6 +125,19 @@ This module defines the following functions: .. versionadded:: 3.4 +The following classes are available: + +.. class:: UID(data) + + Wraps an :class:`int`. This is used when reading or writing NSKeyedArchiver + encoded data, which contains UID (see PList manual). + + It has one attribute, :attr:`data`, which can be used to retrieve the int value + of the UID. :attr:`data` must be in the range `0 <= data <= 2**64`. + + .. versionadded:: 3.8 + + The following constants are available: .. data:: FMT_XML diff --git a/Misc/NEWS.d/next/Documentation/2019-09-07-19-09-01.bpo-38053.lttibE.rst b/Misc/NEWS.d/next/Documentation/2019-09-07-19-09-01.bpo-38053.lttibE.rst new file mode 100644 index 0000000..bc0a987 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2019-09-07-19-09-01.bpo-38053.lttibE.rst @@ -0,0 +1 @@ +Modernized the plistlib documentation
\ No newline at end of file |