Skip to content

Commit 75242e4

Browse files
committed
Remove "See Note" mentions from docstrings
These notes are for internal use, but the docstrings are now used to generate public API docs.
1 parent 4ff9998 commit 75242e4

2 files changed

Lines changed: 0 additions & 5 deletions

File tree

src/django_subatomic/db.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ def savepoint(*, using: str | None = None) -> Generator[None]:
110110
111111
Raises:
112112
_MissingRequiredTransaction: if we are not in a transaction
113-
See Note [_MissingRequiredTransaction in tests]
114113
"""
115114
with (
116115
transaction_required(using=using),
@@ -130,8 +129,6 @@ def transaction_required(*, using: str | None = None) -> Generator[None]:
130129
because we don't want to run the risk of allowing code to pass tests
131130
but fail in production.
132131
133-
See Note [_MissingRequiredTransaction in tests]
134-
135132
Raises:
136133
_MissingRequiredTransaction: if we are not in a transaction.
137134
"""

src/django_subatomic/test.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ def part_of_a_transaction(using: str | None = None) -> Generator[None]:
3131
3232
Note that this does not handle after-commit callback simulation. If you need that,
3333
use [`transaction`][django_subatomic.db.transaction] instead.
34-
35-
See Note [_MissingRequiredTransaction in tests]
3634
"""
3735
with transaction.atomic(using=using):
3836
yield

0 commit comments

Comments
 (0)