summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-01-11 09:55:53 (GMT)
committerGeorg Brandl <georg@python.org>2008-01-11 09:55:53 (GMT)
commite3c3db59b522d18ed60b1e7b0be7d8e9eeec41a7 (patch)
treecd848e76f0b7bb28db9263c5fdd9340e61046a5e /Doc/library
parent2f32c39227e70215c9d9e8e4e50cb1227fc083d1 (diff)
downloadcpython-e3c3db59b522d18ed60b1e7b0be7d8e9eeec41a7.zip
cpython-e3c3db59b522d18ed60b1e7b0be7d8e9eeec41a7.tar.gz
cpython-e3c3db59b522d18ed60b1e7b0be7d8e9eeec41a7.tar.bz2
Documentation for r5990[3567].
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/decimal.rst6
-rw-r--r--Doc/library/difflib.rst5
-rw-r--r--Doc/library/doctest.rst5
-rw-r--r--Doc/library/inspect.rst16
4 files changed, 29 insertions, 3 deletions
diff --git a/Doc/library/decimal.rst b/Doc/library/decimal.rst
index d8942f8..eda09e4 100644
--- a/Doc/library/decimal.rst
+++ b/Doc/library/decimal.rst
@@ -333,7 +333,11 @@ also have a number of specialized methods:
.. method:: Decimal.as_tuple()
- Return a tuple representation of the number: ``(sign, digit_tuple, exponent)``.
+ Return a :term:`named tuple` representation of the number:
+ ``DecimalTuple(sign, digits, exponent)``.
+
+ .. versionchanged:: 2.6
+ Use a named tuple.
.. method:: Decimal.canonical()
diff --git a/Doc/library/difflib.rst b/Doc/library/difflib.rst
index 0ae6699..2610828 100644
--- a/Doc/library/difflib.rst
+++ b/Doc/library/difflib.rst
@@ -344,7 +344,7 @@ use :meth:`set_seq2` to set the commonly used sequence once and call
Find longest matching block in ``a[alo:ahi]`` and ``b[blo:bhi]``.
- If *isjunk* was omitted or ``None``, :meth:`get_longest_match` returns ``(i, j,
+ If *isjunk* was omitted or ``None``, :meth:`find_longest_match` returns ``(i, j,
k)`` such that ``a[i:i+k]`` is equal to ``b[j:j+k]``, where ``alo <= i <= i+k <=
ahi`` and ``blo <= j <= j+k <= bhi``. For all ``(i', j', k')`` meeting those
conditions, the additional conditions ``k >= k'``, ``i <= i'``, and if ``i ==
@@ -373,6 +373,9 @@ use :meth:`set_seq2` to set the commonly used sequence once and call
If no blocks match, this returns ``(alo, blo, 0)``.
+ .. versionchanged:: 2.6
+ This method returns a :term:`named tuple` ``Match(a, b, size)``.
+
.. method:: SequenceMatcher.get_matching_blocks()
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index a231bb4..110411f 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -1506,11 +1506,14 @@ DocTestRunner objects
.. method:: DocTestRunner.summarize([verbose])
Print a summary of all the test cases that have been run by this DocTestRunner,
- and return a tuple ``(failure_count, test_count)``.
+ and return a :term:`named tuple` ``TestResults(failed, attempted)``.
The optional *verbose* argument controls how detailed the summary is. If the
verbosity is not specified, then the :class:`DocTestRunner`'s verbosity is used.
+ .. versionchanged:: 2.6
+ Use a named tuple.
+
.. _doctest-outputchecker:
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index c1f0f00..7893b69 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -214,6 +214,10 @@ Note:
defined in the :mod:`imp` module; see the documentation for that module for
more information on module types.
+ .. versionchanged:: 2.6
+ Returns a :term:`named tuple` ``ModuleInfo(name, suffix, mode,
+ module_type)``.
+
.. function:: getmodulename(path)
@@ -405,6 +409,10 @@ Classes and functions
default argument values or None if there are no default arguments; if this tuple
has *n* elements, they correspond to the last *n* elements listed in *args*.
+ .. versionchanged:: 2.6
+ Returns a :term:`named tuple` ``ArgSpec(args, varargs, keywords,
+ defaults)``.
+
.. function:: getargvalues(frame)
@@ -414,6 +422,10 @@ Classes and functions
names of the ``*`` and ``**`` arguments or ``None``. *locals* is the locals
dictionary of the given frame.
+ .. versionchanged:: 2.6
+ Returns a :term:`named tuple` ``ArgInfo(args, varargs, keywords,
+ locals)``.
+
.. function:: formatargspec(args[, varargs, varkw, defaults, formatarg, formatvarargs, formatvarkw, formatvalue, join])
@@ -479,6 +491,10 @@ line.
Get information about a frame or traceback object. A 5-tuple is returned, the
last five elements of the frame's frame record.
+ .. versionchanged:: 2.6
+ Returns a :term:`named tuple` ``Traceback(filename, lineno, function,
+ code_context, index)``.
+
.. function:: getouterframes(frame[, context])