42 lines
1.9 KiB
Diff
42 lines
1.9 KiB
Diff
From 5d31ce1031e8ca24dc908c319567a76110edd87e Mon Sep 17 00:00:00 2001
|
|
From: Nick Kocharhook <nick@kocharhook.com>
|
|
Date: Wed, 1 Jun 2022 12:16:21 -0700
|
|
Subject: [PATCH] Fix incorrect references to query in testing doc
|
|
|
|
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.
|
|
---
|
|
docs/testing.rst | 8 ++++----
|
|
1 file changed, 4 insertions(+), 4 deletions(-)
|
|
|
|
diff --git a/docs/testing.rst b/docs/testing.rst
|
|
index 6f9d6ee1..8545bd39 100644
|
|
--- a/docs/testing.rst
|
|
+++ b/docs/testing.rst
|
|
@@ -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
|
|
for building the request; you can find the full documentation in
|
|
: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 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
|
|
|
|
|
|
-Pass a dict ``query={"key": "value", ...}`` to set arguments in the
|
|
-query string (after the ``?`` in the URL). Pass a dict ``headers={}``
|
|
-to set request headers.
|
|
+Pass a dict ``query_string={"key": "value", ...}`` to set arguments in
|
|
+the query string (after the ``?`` in the URL). Pass a dict
|
|
+``headers={}`` to set request headers.
|
|
|
|
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,
|
|
--
|
|
2.39.0.windows.2
|
|
|