maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

Fix incorrect references to query in testing doc

Browse source 
The [EnvironBuilder doc](https://werkzeug.palletsprojects.com/en/2.1.x/test/#werkzeug.test.EnvironBuilder) shows that the correct name for the keyword argument is `query_string`, not `query`. Using `query` results in an error.

I've fixed the two places this appears in the testing doc.
This commit is contained in:
Nick Kocharhook 2022-06-01 12:16:21 -07:00 • committed by GitHub
parent 21d32ee067
commit 5d31ce1031
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/testing.rst
View file

@ -92,7 +92,7 @@ The ``client`` has methods that match the common HTTP request methods,
such as ``client.get()`` and ``client.post()``. They take many arguments such as ``client.get()`` and ``client.post()``. They take many arguments
for building the request; you can find the full documentation in for building the request; you can find the full documentation in
:class:`~werkzeug.test.EnvironBuilder`. Typically you'll use ``path``, :class:`~werkzeug.test.EnvironBuilder`. Typically you'll use ``path``,
``query``, ``headers``, and ``data`` or ``json``. ``query_string``, ``headers``, and ``data`` or ``json``.
To make a request, call the method the request should use with the path To make a request, call the method the request should use with the path
to the route to test. A :class:`~werkzeug.test.TestResponse` is returned to the route to test. A :class:`~werkzeug.test.TestResponse` is returned
@ -108,9 +108,9 @@ provides ``response.text``, or use ``response.get_data(as_text=True)``.
assert b"<h2>Hello, World!</h2>" in response.data assert b"<h2>Hello, World!</h2>" in response.data
Pass a dict ``query={"key": "value", ...}`` to set arguments in the Pass a dict ``query_string={"key": "value", ...}`` to set arguments in
query string (after the ``?`` in the URL). Pass a dict ``headers={}`` the query string (after the ``?`` in the URL). Pass a dict
to set request headers. ``headers={}`` to set request headers.
To send a request body in a POST or PUT request, pass a value to To send a request body in a POST or PUT request, pass a value to
``data``. If raw bytes are passed, that exact body is used. Usually, ``data``. If raw bytes are passed, that exact body is used. Usually,