summaryrefslogtreecommitdiffstats
path: root/Doc/library/functions.rst
diff options
context:
space:
mode:
authorChris Jerdonek <chris.jerdonek@gmail.com>2012-10-13 10:22:33 (GMT)
committerChris Jerdonek <chris.jerdonek@gmail.com>2012-10-13 10:22:33 (GMT)
commitf341317185ef7ec6d0cfb2ca93c9d253c3c75305 (patch)
tree08f1a6c5e759c109fdc00c1cc72f676638e43a15 /Doc/library/functions.rst
parent7a9953edfbbd51dbda60ab31c0e5db5eea968b53 (diff)
downloadcpython-f341317185ef7ec6d0cfb2ca93c9d253c3c75305.zip
cpython-f341317185ef7ec6d0cfb2ca93c9d253c3c75305.tar.gz
cpython-f341317185ef7ec6d0cfb2ca93c9d253c3c75305.tar.bz2
Issue #16206: Improve the documentation of the dict constructor.
This change includes replacing the single-line signature documentation with a more complete multiple-line signature.
Diffstat (limited to 'Doc/library/functions.rst')
-rw-r--r--Doc/library/functions.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 572706a..b7d7e08 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -266,14 +266,17 @@ are always available. They are listed here in alphabetical order.
.. _func-dict:
-.. function:: dict([arg])
+.. function:: dict(**kwarg)
+ dict(mapping, **kwarg)
+ dict(iterable, **kwarg)
:noindex:
- Create a new data dictionary, optionally with items taken from *arg*.
- The dictionary type is described in :ref:`typesmapping`.
+ Create a new dictionary. The :class:`dict` object is the dictionary class.
+ See :class:`dict` and :ref:`typesmapping` for documentation about this
+ class.
- For other containers see the built in :class:`list`, :class:`set`, and
- :class:`tuple` classes, and the :mod:`collections` module.
+ For other containers see the built-in :class:`list`, :class:`set`, and
+ :class:`tuple` classes, as well as the :mod:`collections` module.
.. function:: dir([object])