From 006d907afc138a99869481c198eaf39a918df99d Mon Sep 17 00:00:00 2001 From: Chris Jerdonek Date: Fri, 12 Oct 2012 20:28:26 -0700 Subject: [PATCH] Undo changes accidentally reverted in de8787029fe4. --- Doc/howto/functional.rst | 5 +++-- Doc/library/functions.rst | 25 ++++++++++++++++--------- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/Doc/howto/functional.rst b/Doc/howto/functional.rst index ebbb229e570..b621a84f56f 100644 --- a/Doc/howto/functional.rst +++ b/Doc/howto/functional.rst @@ -292,13 +292,14 @@ ordering of the objects in the dictionary. Applying :func:`iter` to a dictionary always loops over the keys, but dictionaries have methods that return other iterators. If you want to iterate over values or key/value pairs, you can explicitly call the -:meth:`~dict.values` or :meth:`~dict.items` methods to get an appropriate iterator. +:meth:`~dict.values` or :meth:`~dict.items` methods to get an appropriate +iterator. The :func:`dict` constructor can accept an iterator that returns a finite stream of ``(key, value)`` tuples: >>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')] - >>> dict(iter(L)) + >>> dict(iter(L)) #doctest: +SKIP {'Italy': 'Rome', 'US': 'Washington DC', 'France': 'Paris'} Files also support iteration by calling the :meth:`~io.TextIOBase.readline` diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 173baf488ae..f7826553942 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -122,6 +122,8 @@ are always available. They are listed here in alphabetical order. Without an argument, an array of size 0 is created. + See also :ref:`binaryseq` and :ref:`typebytearray`. + .. _func-bytes: .. function:: bytes([source[, encoding[, errors]]]) @@ -135,6 +137,8 @@ are always available. They are listed here in alphabetical order. Bytes objects can also be created with literals, see :ref:`strings`. + See also :ref:`binaryseq`, :ref:`typebytes`, and :ref:`bytes-methods`. + .. function:: callable(object) @@ -688,6 +692,8 @@ are always available. They are listed here in alphabetical order. *sentinel*, :exc:`StopIteration` will be raised, otherwise the value will be returned. + See also :ref:`typeiter`. + One useful application of the second form of :func:`iter` is to read lines of a file until a certain line is reached. The following example reads a file until the :meth:`readline` method returns an empty string:: @@ -708,7 +714,7 @@ are always available. They are listed here in alphabetical order. :noindex: Rather than being a function, :class:`list` is actually a mutable - sequence type, as documented in :ref:`typesseq`. + sequence type, as documented in :ref:`typesseq-list` and :ref:`typesseq`. .. function:: locals() @@ -1082,7 +1088,7 @@ are always available. They are listed here in alphabetical order. :noindex: Rather than being a function, :class:`range` is actually an immutable - sequence type, as documented in :ref:`typesseq`. + sequence type, as documented in :ref:`typesseq-range` and :ref:`typesseq`. .. function:: repr(object) @@ -1207,7 +1213,8 @@ are always available. They are listed here in alphabetical order. .. function:: str(object='') str(object[, encoding[, errors]]) - Return a string version of an object, using one of the following modes: + Return a :ref:`string ` version of an object, using one of the + following modes: If *encoding* and/or *errors* are given, :func:`str` will decode the *object* which can either be a byte string or a character buffer using @@ -1230,11 +1237,9 @@ are always available. They are listed here in alphabetical order. Objects can specify what ``str(object)`` returns by defining a :meth:`__str__` special method. - For more information on strings see :ref:`typesseq` which describes sequence - functionality (strings are sequences), and also the string-specific methods - described in the :ref:`string-methods` section. To output formatted strings, - see the :ref:`string-formatting` section. In addition see the - :ref:`stringservices` section. + For more information on strings and string methods, see the :ref:`textseq` + section. To output formatted strings, see the :ref:`string-formatting` + section. In addition, see the :ref:`stringservices` section. .. function:: sum(iterable[, start]) @@ -1311,7 +1316,7 @@ are always available. They are listed here in alphabetical order. :noindex: Rather than being a function, :class:`tuple` is actually an immutable - sequence type, as documented in :ref:`typesseq`. + sequence type, as documented in :ref:`typesseq-tuple` and :ref:`typesseq`. .. function:: type(object) @@ -1344,6 +1349,8 @@ are always available. They are listed here in alphabetical order. ... >>> X = type('X', (object,), dict(a=1)) + See also :ref:`bltin-type-objects`. + .. function:: vars([object])