mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 08:59:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)

Browse source
This commit is contained in:
Serhiy Storchaka 2018-12-19 08:09:46 +02:00 • committed by GitHub
parent 82d73554e4
commit 2b57c43f21
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
45 changed files with 240 additions and 242 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/library/contextlib.rst
View file

@ -1,5 +1,5 @@
:mod:`contextlib` --- Utilities for :keyword:`with`\ -statement contexts
========================================================================
:mod:`!contextlib` --- Utilities for :keyword:`!with`\ -statement contexts
==========================================================================
.. module:: contextlib
:synopsis: Utilities for with-statement contexts.
@ -72,7 +72,7 @@ Functions and classes provided:
The function being decorated must return a :term:`generator`-iterator when
called. This iterator must yield exactly one value, which will be bound to
the targets in the :keyword:`with` statement's :keyword:`as` clause, if any.
the targets in the :keyword:`with` statement's :keyword:`!as` clause, if any.
At the point where the generator yields, the block nested in the :keyword:`with`
statement is executed. The generator is then resumed after the block is exited.
@ -82,9 +82,9 @@ Functions and classes provided:
the error (if any), or ensure that some cleanup takes place. If an exception is
trapped merely in order to log it or to perform some action (rather than to
suppress it entirely), the generator must reraise that exception. Otherwise the
generator context manager will indicate to the :keyword:`with` statement that
generator context manager will indicate to the :keyword:`!with` statement that
the exception has been handled, and execution will resume with the statement
immediately following the :keyword:`with` statement.
immediately following the :keyword:`!with` statement.
:func:`contextmanager` uses :class:`ContextDecorator` so the context managers
it creates can be used as decorators as well as in :keyword:`with` statements.
@ -346,7 +346,7 @@ Functions and classes provided:
As the decorated function must be able to be called multiple times, the
underlying context manager must support use in multiple :keyword:`with`
statements. If this is not the case, then the original construct with the
explicit :keyword:`with` statement inside the function should be used.
explicit :keyword:`!with` statement inside the function should be used.
.. versionadded:: 3.2
@ -771,7 +771,7 @@ Reentrant context managers
More sophisticated context managers may be "reentrant". These context
managers can not only be used in multiple :keyword:`with` statements,
but may also be used *inside* a :keyword:`with` statement that is already
but may also be used *inside* a :keyword:`!with` statement that is already
using the same context manager.
:class:`threading.RLock` is an example of a reentrant context manager, as are