diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/stdtypes.rst | 20 | ||||
| -rw-r--r-- | Doc/library/test.rst | 10 |
2 files changed, 19 insertions, 11 deletions
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index 14aa28d..c97e9ae 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -1539,7 +1539,7 @@ proper superset of the second set (is a superset, but is not equal). Instances of :class:`set` are compared to instances of :class:`frozenset` based on their members. For example, ``set('abc') == frozenset('abc')`` returns -``True``. +``True`` and so does ``set('abc') in set([frozenset('abc')])``. The subset and equality comparisons do not generalize to a complete ordering function. For example, any two disjoint sets are not equal and are not subsets @@ -1578,18 +1578,18 @@ apply to immutable instances of :class:`frozenset`: Update the set, keeping only elements found in either set, but not in both. -.. method:: set.add(el) +.. method:: set.add(elem) - Add element *el* to the set. + Add element *elem* to the set. -.. method:: set.remove(el) +.. method:: set.remove(elem) - Remove element *el* from the set. Raises :exc:`KeyError` if *el* is not + Remove element *elem* from the set. Raises :exc:`KeyError` if *elem* is not contained in the set. -.. method:: set.discard(el) +.. method:: set.discard(elem) - Remove element *el* from the set if it is present. + Remove element *elem* from the set if it is present. .. method:: set.pop() @@ -1606,6 +1606,12 @@ Note, the non-operator versions of the :meth:`update`, :meth:`symmetric_difference_update` methods will accept any iterable as an argument. +Note, the *elem* argument to the :meth:`__contains__`, :meth:`remove`, and +:meth:`discard` methods may be a set. To support searching for an equivalent +frozenset, the *elem* set is temporarily mutated during the search and then +restored. During the search, the *elem* set should not be read or mutated +since it does not have a meaningful value. + .. _typesmapping: diff --git a/Doc/library/test.rst b/Doc/library/test.rst index 6c35d50..a6a3584 100644 --- a/Doc/library/test.rst +++ b/Doc/library/test.rst @@ -283,13 +283,15 @@ The :mod:`test.test_support` module defines the following functions: This will run all tests defined in the named module. -.. function:: catch_warning() +.. function:: catch_warning(record=True) - This is a context manager that guards the warnings filter from being + Return a context manager that guards the warnings filter from being permanently changed and records the data of the last warning that has been - issued. + issued. The ``record`` argument specifies whether any raised warnings are + captured by the object returned by :func:`warnings.catch_warning` or allowed + to propagate as normal. - Use like this:: + The context manager is typically used like this:: with catch_warning() as w: warnings.warn("foo") |