Skip to content

Commit 043c921

Browse files
kosdmitbluetech
authored andcommitted
Add docstrings to user visible fixtures
1 parent f3fe5b1 commit 043c921

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

pytest_django/fixtures.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -656,11 +656,13 @@ def _assert_num_queries(
656656

657657
@pytest.fixture()
658658
def django_assert_num_queries(pytestconfig: pytest.Config) -> DjangoAssertNumQueries:
659+
"""Allows to check for an expected number of DB queries."""
659660
return partial(_assert_num_queries, pytestconfig)
660661

661662

662663
@pytest.fixture()
663664
def django_assert_max_num_queries(pytestconfig: pytest.Config) -> DjangoAssertNumQueries:
665+
"""Allows to check for an expected maximum number of DB queries."""
664666
return partial(_assert_num_queries, pytestconfig, exact=False)
665667

666668

@@ -678,6 +680,7 @@ def __call__(
678680

679681
@pytest.fixture()
680682
def django_capture_on_commit_callbacks() -> DjangoCaptureOnCommitCallbacks:
683+
"""Captures transaction.on_commit() callbacks for the given database connection."""
681684
from django.test import TestCase
682685

683686
return TestCase.captureOnCommitCallbacks # type: ignore[no-any-return]

0 commit comments

Comments
 (0)