forked from orbit-oss/flask
Merge pull request #1801 from ben4ever/fix_doc_with_formatting
Fix "with" formatting in doc
This commit is contained in:
commit
8011e1de28
1 changed files with 5 additions and 4 deletions
|
|
@ -39,8 +39,9 @@ def make_test_environ_builder(app, path='/', base_url=None, *args, **kwargs):
|
||||||
class FlaskClient(Client):
|
class FlaskClient(Client):
|
||||||
"""Works like a regular Werkzeug test client but has some knowledge about
|
"""Works like a regular Werkzeug test client but has some knowledge about
|
||||||
how Flask works to defer the cleanup of the request context stack to the
|
how Flask works to defer the cleanup of the request context stack to the
|
||||||
end of a with body when used in a with statement. For general information
|
end of a ``with`` body when used in a ``with`` statement. For general
|
||||||
about how to use this class refer to :class:`werkzeug.test.Client`.
|
information about how to use this class refer to
|
||||||
|
:class:`werkzeug.test.Client`.
|
||||||
|
|
||||||
Basic usage is outlined in the :ref:`testing` chapter.
|
Basic usage is outlined in the :ref:`testing` chapter.
|
||||||
"""
|
"""
|
||||||
|
|
@ -49,9 +50,9 @@ class FlaskClient(Client):
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def session_transaction(self, *args, **kwargs):
|
def session_transaction(self, *args, **kwargs):
|
||||||
"""When used in combination with a with statement this opens a
|
"""When used in combination with a ``with`` statement this opens a
|
||||||
session transaction. This can be used to modify the session that
|
session transaction. This can be used to modify the session that
|
||||||
the test client uses. Once the with block is left the session is
|
the test client uses. Once the ``with`` block is left the session is
|
||||||
stored back.
|
stored back.
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue