[Python-checkins] cpython (3.3): #17438: add links to the conversion tables in dump(s)/load(s).

Fri Mar 29 03:02:32 CET 2013

http://hg.python.org/cpython/rev/e76952bd4fa5
changeset: 82997:e76952bd4fa5
branch: 3.3
parent: 82994:b1c511418b29
user: Ezio Melotti <ezio.melotti at gmail.com>
date: Fri Mar 29 03:59:29 2013 +0200
summary:
 #17438: add links to the conversion tables in dump(s)/load(s).
files:
 Doc/library/json.rst | 17 ++++++++++++-----
 1 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/Doc/library/json.rst b/Doc/library/json.rst
--- a/Doc/library/json.rst
+++ b/Doc/library/json.rst
@@ -124,7 +124,8 @@
 sort_keys=False, **kw)
 
 Serialize *obj* as a JSON formatted stream to *fp* (a ``.write()``-supporting
- :term:`file-like object`).
+ :term:`file-like object`) using this :ref:`conversion table
+ <py-to-json-table>`.
 
 If *skipkeys* is ``True`` (default: ``False``), then dict keys that are not
 of a basic type (:class:`str`, :class:`int`, :class:`float`, :class:`bool`,
@@ -183,8 +184,9 @@
 indent=None, separators=None, default=None, \
 sort_keys=False, **kw)
 
- Serialize *obj* to a JSON formatted :class:`str`. The arguments have the
- same meaning as in :func:`dump`.
+ Serialize *obj* to a JSON formatted :class:`str` using this :ref:`conversion
+ table <py-to-json-table>`. The arguments have the same meaning as in
+ :func:`dump`.
 
 .. note::
 
@@ -204,7 +206,8 @@
 .. function:: load(fp, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
 
 Deserialize *fp* (a ``.read()``-supporting :term:`file-like object`
- containing a JSON document) to a Python object.
+ containing a JSON document) to a Python object using this :ref:`conversion
+ table <json-to-py-table>`.
 
 *object_hook* is an optional function that will be called with the result of
 any object literal decoded (a :class:`dict`). The return value of
@@ -249,7 +252,7 @@
 .. function:: loads(s, encoding=None, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
 
 Deserialize *s* (a :class:`str` instance containing a JSON document) to a
- Python object.
+ Python object using this :ref:`conversion table <json-to-py-table>`.
 
 The other arguments have the same meaning as in :func:`load`, except
 *encoding* which is ignored and deprecated.
@@ -264,6 +267,8 @@
 
 Performs the following translations in decoding by default:
 
+ .. _json-to-py-table:
+
 +---------------+-------------------+
 | JSON | Python |
 +===============+===================+
@@ -345,6 +350,8 @@
 
 Supports the following objects and types by default:
 
+ .. _py-to-json-table:
+
 +-------------------+---------------+
 | Python | JSON |
 +===================+===============+
-- 
Repository URL: http://hg.python.org/cpython
