Skip to content

Commit 0e375ec

Browse files
authored
Merge pull request #674 from minusf/num_queries_doc
minor fixes in django helpers
2 parents 08434f7 + 9649949 commit 0e375ec

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/helpers.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -283,17 +283,20 @@ Example
283283
``django_assert_num_queries``
284284
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
285285

286-
.. py:function:: django_assert_num_queries(connection=None, info=None)
286+
.. py:function:: django_assert_num_queries(num, connection=None, info=None)
287287
288+
:param num: expected number of queries
288289
:param connection: optional non-default DB connection
289290
:param str info: optional info message to display on failure
290291

291292
This fixture allows to check for an expected number of DB queries.
292293

294+
If the assertion failed, the executed queries can be shown by using
295+
the verbose command line option.
296+
293297
It wraps `django.test.utils.CaptureQueriesContext` and yields the wrapped
294298
CaptureQueriesContext instance.
295299

296-
297300
Example usage::
298301

299302
def test_queries(django_assert_num_queries):
@@ -310,8 +313,9 @@ Example usage::
310313
``django_assert_max_num_queries``
311314
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
312315

313-
.. py:function:: django_assert_num_queries(connection=None, info=None)
316+
.. py:function:: django_assert_max_num_queries(num, connection=None, info=None)
314317
318+
:param num: expected maximum number of queries
315319
:param connection: optional non-default DB connection
316320
:param str info: optional info message to display on failure
317321

@@ -322,7 +326,7 @@ It is a specialized version of :fixture:`django_assert_num_queries`.
322326
Example usage::
323327

324328
def test_max_queries(django_assert_max_num_queries):
325-
with django_assert_max_num_queries(3):
329+
with django_assert_max_num_queries(2):
326330
Item.objects.create('foo')
327331
Item.objects.create('bar')
328332

0 commit comments

Comments
 (0)