summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code
diff options
context:
space:
mode:
authorMike Edmunds <medmunds@gmail.com>2025-07-16 04:49:03 -0700
committerGitHub <noreply@github.com>2025-07-16 08:49:03 -0300
commitf42b89f1bf49a5b89ed852b60f79342320a81c5e (patch)
treef811ffa528b2f9fb3769b5052c53e90b0ac59878 /docs/internals/contributing/writing-code
parent10386fac00be55e73279459f00f1959c3ef30a1c (diff)
Fixed #36477, Refs #36163 -- Added @deprecate_posargs decorator to simplify deprecation of positional arguments.
This helper allows marking positional-or-keyword parameters as keyword-only with a deprecation period, in a consistent and correct manner.
Diffstat (limited to 'docs/internals/contributing/writing-code')
-rw-r--r--docs/internals/contributing/writing-code/submitting-patches.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt
index fe354a0ba1..b8ead27ded 100644
--- a/docs/internals/contributing/writing-code/submitting-patches.txt
+++ b/docs/internals/contributing/writing-code/submitting-patches.txt
@@ -312,6 +312,11 @@ Once you have completed these steps, you are finished with the deprecation.
In each :term:`feature release <Feature release>`, all
``RemovedInDjangoXXWarning``\s matching the new version are removed.
+The ``django.utils.deprecation`` module provides some helpful deprecation
+utilities, such as a ``@deprecate_posargs`` decorator to assist with converting
+positional-or-keyword arguments to keyword-only. See the inline documentation
+in the module source.
+
JavaScript contributions
========================