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)
This commit is contained in:
Jon Janzen 2019-09-09 09:13:43 -05:00 committed by Ronald Oussoren
parent c638521dbf
commit 24b11b8c95
2 changed files with 19 additions and 4 deletions

View file

@ -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

View file

@ -0,0 +1 @@
Modernized the plistlib documentation