Link to "XRange Type" section in xrange() built-in function documentation.

This commit is contained in:
Chris Jerdonek 2012-11-14 02:13:28 -08:00
parent 4a3a3f3bda
commit 9e173ebde2

View file

@ -1523,14 +1523,16 @@ available. They are listed here in alphabetical order.
.. function:: xrange(stop) .. function:: xrange(stop)
xrange(start, stop[, step]) xrange(start, stop[, step])
This function is very similar to :func:`range`, but returns an "xrange object" This function is very similar to :func:`range`, but returns an :ref:`xrange
object <typesseq-xrange>`
instead of a list. This is an opaque sequence type which yields the same values instead of a list. This is an opaque sequence type which yields the same values
as the corresponding list, without actually storing them all simultaneously. as the corresponding list, without actually storing them all simultaneously.
The advantage of :func:`xrange` over :func:`range` is minimal (since The advantage of :func:`xrange` over :func:`range` is minimal (since
:func:`xrange` still has to create the values when asked for them) except when a :func:`xrange` still has to create the values when asked for them) except when a
very large range is used on a memory-starved machine or when all of the range's very large range is used on a memory-starved machine or when all of the range's
elements are never used (such as when the loop is usually terminated with elements are never used (such as when the loop is usually terminated with
:keyword:`break`). :keyword:`break`). For more information on xrange objects, see
:ref:`typesseq-xrange` and :ref:`typesseq`.
.. impl-detail:: .. impl-detail::