summaryrefslogtreecommitdiff
path: root/docs/releases
diff options
context:
space:
mode:
authorSaJH <wogur981208@gmail.com>2025-08-26 00:50:53 +0900
committerSarah Boyce <42296566+sarahboyce@users.noreply.github.com>2025-08-28 08:52:43 +0200
commit3c0c54351b58e9386375d2bd7a8c60dadc4bb6e8 (patch)
tree38a78ca516fc998ae29818fa7950af5278bc7c9b /docs/releases
parent1285de557b0b8b9c5ebe5de0114b2da5abe60f80 (diff)
Fixed #36570 -- Removed unnecessary :py domain from documentation roles.
Signed-off-by: SaJH <wogur981208@gmail.com>
Diffstat (limited to 'docs/releases')
-rw-r--r--docs/releases/1.10.txt2
-rw-r--r--docs/releases/1.8.txt12
-rw-r--r--docs/releases/3.0.txt2
-rw-r--r--docs/releases/3.1.3.txt2
-rw-r--r--docs/releases/3.1.txt2
-rw-r--r--docs/releases/3.2.txt20
-rw-r--r--docs/releases/4.0.txt6
-rw-r--r--docs/releases/4.1.txt4
-rw-r--r--docs/releases/4.2.txt6
-rw-r--r--docs/releases/5.1.txt2
-rw-r--r--docs/releases/5.2.txt4
-rw-r--r--docs/releases/6.0.txt15
12 files changed, 40 insertions, 37 deletions
diff --git a/docs/releases/1.10.txt b/docs/releases/1.10.txt
index 0c0da89643..4d04db521f 100644
--- a/docs/releases/1.10.txt
+++ b/docs/releases/1.10.txt
@@ -448,7 +448,7 @@ Requests and Responses
* Added :class:`~django.http.HttpResponse` methods
:meth:`~django.http.HttpResponse.readable` and
:meth:`~django.http.HttpResponse.seekable` to make an instance a
- stream-like object and allow wrapping it with :py:class:`io.TextIOWrapper`.
+ stream-like object and allow wrapping it with :class:`io.TextIOWrapper`.
* Added the :attr:`HttpRequest.content_type
<django.http.HttpRequest.content_type>` and
diff --git a/docs/releases/1.8.txt b/docs/releases/1.8.txt
index a63f14ca51..33c2635c64 100644
--- a/docs/releases/1.8.txt
+++ b/docs/releases/1.8.txt
@@ -275,7 +275,7 @@ Cryptography
* The ``max_age`` parameter of the
:meth:`django.core.signing.TimestampSigner.unsign` method now also accepts a
- :py:class:`datetime.timedelta` object.
+ :class:`datetime.timedelta` object.
Database backends
~~~~~~~~~~~~~~~~~
@@ -384,7 +384,7 @@ Generic Views
* Placeholders in :attr:`ModelFormMixin.success_url
<django.views.generic.edit.ModelFormMixin.success_url>` now support the
- Python :py:meth:`str.format` syntax. The legacy ``%(<foo>)s`` syntax is still
+ Python :meth:`str.format` syntax. The legacy ``%(<foo>)s`` syntax is still
supported but will be removed in Django 1.10.
Internationalization
@@ -753,7 +753,7 @@ Management commands that only accept positional arguments
If you have written a custom management command that only accepts positional
arguments and you didn't specify the ``args`` command variable, you might get
an error like ``Error: unrecognized arguments: ...``, as variable parsing is
-now based on :py:mod:`argparse` which doesn't implicitly accept positional
+now based on :mod:`argparse` which doesn't implicitly accept positional
arguments. You can make your command backwards compatible by simply setting the
``args`` class variable. However, if you don't have to keep compatibility with
older Django versions, it's better to implement the new
@@ -766,10 +766,10 @@ Custom test management command arguments through test runner
The method to add custom arguments to the ``test`` management command through
the test runner has changed. Previously, you could provide an ``option_list``
class variable on the test runner to add more arguments (à la
-:py:mod:`optparse`). Now to implement the same behavior, you have to create an
+:mod:`optparse`). Now to implement the same behavior, you have to create an
``add_arguments(cls, parser)`` class method on the test runner and call
``parser.add_argument`` to add any custom arguments, as parser is now an
-:py:class:`argparse.ArgumentParser` instance.
+:class:`argparse.ArgumentParser` instance.
Model check ensures auto-generated column names are within limits specified by database
---------------------------------------------------------------------------------------
@@ -1407,7 +1407,7 @@ in Django 1.10:
Extending management command arguments through ``Command.option_list``
----------------------------------------------------------------------
-Management commands now use :py:mod:`argparse` instead of :py:mod:`optparse` to
+Management commands now use :mod:`argparse` instead of :mod:`optparse` to
parse command-line arguments passed to commands. This also means that the way
to add custom arguments to commands has changed: instead of extending the
``option_list`` class list, you should now override the
diff --git a/docs/releases/3.0.txt b/docs/releases/3.0.txt
index 1332a646ae..3cf841b8b9 100644
--- a/docs/releases/3.0.txt
+++ b/docs/releases/3.0.txt
@@ -285,7 +285,7 @@ Models
* The new :attr:`.Field.descriptor_class` attribute allows model fields to
customize the get and set behavior by overriding their
- :py:ref:`descriptors <descriptors>`.
+ :ref:`descriptors <descriptors>`.
* :class:`~django.db.models.Avg` and :class:`~django.db.models.Sum` now support
the ``distinct`` argument.
diff --git a/docs/releases/3.1.3.txt b/docs/releases/3.1.3.txt
index c51e0dd4a8..153d49571f 100644
--- a/docs/releases/3.1.3.txt
+++ b/docs/releases/3.1.3.txt
@@ -43,7 +43,7 @@ Bugfixes
* Fixed a regression in Django 3.1 where
:exc:`ProtectedError.protected_objects <django.db.models.ProtectedError>` and
:exc:`RestrictedError.restricted_objects <django.db.models.RestrictedError>`
- attributes returned iterators instead of :py:class:`set` of objects
+ attributes returned iterators instead of :class:`set` of objects
(:ticket:`32107`).
* Fixed a regression in Django 3.1.2 that caused incorrect form input layout on
diff --git a/docs/releases/3.1.txt b/docs/releases/3.1.txt
index 0c2041c5a2..7dc20f1b1b 100644
--- a/docs/releases/3.1.txt
+++ b/docs/releases/3.1.txt
@@ -407,7 +407,7 @@ Models
SQL on MySQL by using ``DELETE`` instead of ``TRUNCATE`` statements for
tables which don't require resetting sequences.
-* SQLite functions are now marked as :py:meth:`deterministic
+* SQLite functions are now marked as :meth:`deterministic
<sqlite3.Connection.create_function>` on Python 3.8+. This allows using them
in check constraints and partial indexes.
diff --git a/docs/releases/3.2.txt b/docs/releases/3.2.txt
index 9a49075d37..6813063160 100644
--- a/docs/releases/3.2.txt
+++ b/docs/releases/3.2.txt
@@ -406,11 +406,11 @@ Models
* :class:`Value() <django.db.models.Value>` expression now
automatically resolves its ``output_field`` to the appropriate
:class:`Field <django.db.models.Field>` subclass based on the type of
- its provided ``value`` for :py:class:`bool`, :py:class:`bytes`,
- :py:class:`float`, :py:class:`int`, :py:class:`str`,
- :py:class:`datetime.date`, :py:class:`datetime.datetime`,
- :py:class:`datetime.time`, :py:class:`datetime.timedelta`,
- :py:class:`decimal.Decimal`, and :py:class:`uuid.UUID` instances. As a
+ its provided ``value`` for :class:`bool`, :class:`bytes`,
+ :class:`float`, :class:`int`, :class:`str`,
+ :class:`datetime.date`, :class:`datetime.datetime`,
+ :class:`datetime.time`, :class:`datetime.timedelta`,
+ :class:`decimal.Decimal`, and :class:`uuid.UUID` instances. As a
consequence, resolving an ``output_field`` for database functions and
combined expressions may now crash with mixed types when using ``Value()``.
You will need to explicitly set the ``output_field`` in such cases.
@@ -519,11 +519,11 @@ Tests
* Objects assigned to class attributes in :meth:`.TestCase.setUpTestData` are
now isolated for each test method. Such objects are now required to support
- creating deep copies with :py:func:`copy.deepcopy`. Assigning objects which
+ creating deep copies with :func:`copy.deepcopy`. Assigning objects which
don't support ``deepcopy()`` is deprecated and will be removed in Django 4.1.
* :class:`~django.test.runner.DiscoverRunner` now enables
- :py:mod:`faulthandler` by default. This can be disabled by using the
+ :mod:`faulthandler` by default. This can be disabled by using the
:option:`test --no-faulthandler` option.
* :class:`~django.test.runner.DiscoverRunner` and the
@@ -703,8 +703,8 @@ Miscellaneous
removed. Please use :func:`urllib.parse.parse_qsl` instead.
* ``django.test.utils.TestContextDecorator`` now uses
- :py:meth:`~unittest.TestCase.addCleanup` so that cleanups registered in the
- :py:meth:`~unittest.TestCase.setUp` method are called before
+ :meth:`~unittest.TestCase.addCleanup` so that cleanups registered in the
+ :meth:`~unittest.TestCase.setUp` method are called before
``TestContextDecorator.disable()``.
* ``SessionMiddleware`` now raises a
@@ -758,7 +758,7 @@ Miscellaneous
-------------
* Assigning objects which don't support creating deep copies with
- :py:func:`copy.deepcopy` to class attributes in
+ :func:`copy.deepcopy` to class attributes in
:meth:`.TestCase.setUpTestData` is deprecated.
* Using a boolean value in :attr:`.BaseCommand.requires_system_checks` is
diff --git a/docs/releases/4.0.txt b/docs/releases/4.0.txt
index c7d63ee293..69f7309b44 100644
--- a/docs/releases/4.0.txt
+++ b/docs/releases/4.0.txt
@@ -289,7 +289,7 @@ Management Commands
* On PostgreSQL, :djadmin:`dbshell` now supports specifying a password file.
-* The :djadmin:`shell` command now respects :py:data:`sys.__interactivehook__`
+* The :djadmin:`shell` command now respects :data:`sys.__interactivehook__`
at startup. This allows loading shell history between interactive sessions.
As a consequence, ``readline`` is no longer loaded if running in *isolated*
mode.
@@ -349,7 +349,7 @@ Signals
* The new ``stdout`` argument for :func:`~django.db.models.signals.pre_migrate`
and :func:`~django.db.models.signals.post_migrate` signals allows redirecting
output to a stream-like object. It should be preferred over
- :py:data:`sys.stdout` and :py:func:`print` when emitting verbose output in
+ :data:`sys.stdout` and :func:`print` when emitting verbose output in
order to allow proper capture when testing.
Templates
@@ -370,7 +370,7 @@ Tests
* The :option:`test --buffer` option now supports parallel tests.
* The new ``logger`` argument to :class:`~django.test.runner.DiscoverRunner`
- allows a Python :py:ref:`logger <logger>` to be used for logging.
+ allows a Python :ref:`logger <logger>` to be used for logging.
* The new :meth:`.DiscoverRunner.log` method provides a way to log messages
that uses the ``DiscoverRunner.logger``, or prints to the console if not set.
diff --git a/docs/releases/4.1.txt b/docs/releases/4.1.txt
index 10b9f3728a..df614357a3 100644
--- a/docs/releases/4.1.txt
+++ b/docs/releases/4.1.txt
@@ -536,7 +536,7 @@ Miscellaneous
* :class:`~django.test.runner.DiscoverRunner` now returns a non-zero error code
for unexpected successes from tests marked with
- :py:func:`unittest.expectedFailure`.
+ :func:`unittest.expectedFailure`.
* :class:`~django.middleware.csrf.CsrfViewMiddleware` no longer masks the CSRF
cookie like it does the CSRF token in the DOM.
@@ -608,7 +608,7 @@ Features deprecated in 4.1
Log out via GET
---------------
-Logging out via ``GET`` requests to the :py:class:`built-in logout view
+Logging out via ``GET`` requests to the :class:`built-in logout view
<django.contrib.auth.views.LogoutView>` is deprecated. Use ``POST`` requests
instead.
diff --git a/docs/releases/4.2.txt b/docs/releases/4.2.txt
index 37cf228dc7..de65236914 100644
--- a/docs/releases/4.2.txt
+++ b/docs/releases/4.2.txt
@@ -475,8 +475,8 @@ Miscellaneous
* Support for ``PROJ`` < 5 is removed.
* :class:`~django.core.mail.backends.smtp.EmailBackend` now verifies a
- :py:attr:`hostname <ssl.SSLContext.check_hostname>` and
- :py:attr:`certificates <ssl.SSLContext.verify_mode>`. If you need the
+ :attr:`hostname <ssl.SSLContext.check_hostname>` and
+ :attr:`certificates <ssl.SSLContext.verify_mode>`. If you need the
previous behavior that is less restrictive and not recommended, subclass
``EmailBackend`` and override the ``ssl_context`` property.
@@ -564,7 +564,7 @@ Miscellaneous
* The ``BaseUserManager.make_random_password()`` method is deprecated. See
`recipes and best practices
<https://docs.python.org/3/library/secrets.html#recipes-and-best-practices>`_
- for using Python's :py:mod:`secrets` module to generate passwords.
+ for using Python's :mod:`secrets` module to generate passwords.
* The ``length_is`` template filter is deprecated in favor of :tfilter:`length`
and the ``==`` operator within an :ttag:`{% if %}<if>` tag. For example
diff --git a/docs/releases/5.1.txt b/docs/releases/5.1.txt
index 0a5ececcca..32d32cf9e7 100644
--- a/docs/releases/5.1.txt
+++ b/docs/releases/5.1.txt
@@ -382,7 +382,7 @@ Miscellaneous
* ``django.utils.text.Truncator`` used by :tfilter:`truncatechars_html` and
:tfilter:`truncatewords_html` template filters now uses
- :py:class:`html.parser.HTMLParser` subclasses. This results in a more robust
+ :class:`html.parser.HTMLParser` subclasses. This results in a more robust
and faster operation, but there may be small differences in the output.
* The undocumented ``django.urls.converters.get_converter()`` function is
diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt
index d5ecce48d7..fa005bd550 100644
--- a/docs/releases/5.2.txt
+++ b/docs/releases/5.2.txt
@@ -380,8 +380,8 @@ Utilities
~~~~~~~~~
* :class:`~django.utils.safestring.SafeString` now returns
- :py:data:`NotImplemented` in ``__add__`` for non-string right-hand side
- values. This aligns with the :py:class:`str` addition behavior and allows
+ :data:`NotImplemented` in ``__add__`` for non-string right-hand side
+ values. This aligns with the :class:`str` addition behavior and allows
``__radd__`` to be used if available.
* :func:`~django.utils.html.format_html_join` now supports taking an iterable
diff --git a/docs/releases/6.0.txt b/docs/releases/6.0.txt
index e54b9788ce..94376b9994 100644
--- a/docs/releases/6.0.txt
+++ b/docs/releases/6.0.txt
@@ -79,15 +79,15 @@ Adoption of Python's modern email API
Email handling in Django now uses Python's modern email API, introduced in
Python 3.6. This API, centered around the
-:py:class:`email.message.EmailMessage` class, offers a cleaner and
+:class:`email.message.EmailMessage` class, offers a cleaner and
Unicode-friendly interface for composing and sending emails. It replaces use of
Python's older legacy (``Compat32``) API, which relied on lower-level MIME
-classes (from :py:mod:`email.mime`) and required more manual handling of
+classes (from :mod:`email.mime`) and required more manual handling of
message structure and encoding.
Notably, the return type of the :class:`EmailMessage.message()
<django.core.mail.EmailMessage>` method is now an instance of Python's
-:py:class:`email.message.EmailMessage`. This supports the same API as the
+:class:`email.message.EmailMessage`. This supports the same API as the
previous ``SafeMIMEText`` and ``SafeMIMEMultipart`` return types, but is not an
instance of those now-deprecated classes.
@@ -228,7 +228,7 @@ Email
* The new ``policy`` argument for :class:`EmailMessage.message()
<django.core.mail.EmailMessage>` allows specifying the email policy, the set
of rules for updating and serializing the representation of the message.
- Defaults to :py:data:`email.policy.default`.
+ Defaults to :data:`email.policy.default`.
* :class:`EmailMessage.attach() <django.core.mail.EmailMessage>` now accepts a
:class:`~email.message.MIMEPart` object from Python's modern email API.
@@ -439,7 +439,7 @@ Email
* The undocumented ``encoding`` property of
:class:`~django.core.mail.EmailMessage` no longer supports Python legacy
- :py:class:`email.charset.Charset` objects.
+ :class:`email.charset.Charset` objects.
* As the internal implementations of :class:`~django.core.mail.EmailMessage`
and :class:`~django.core.mail.EmailMultiAlternatives` have changed
@@ -471,7 +471,7 @@ Miscellaneous
at the end of the output, even without the ``indent`` option set.
* The undocumented ``django.utils.http.parse_header_parameters()`` function is
- refactored to use Python's :py:class:`email.message.Message` for parsing.
+ refactored to use Python's :class:`email.message.Message` for parsing.
Input headers exceeding 10000 characters will now raise :exc:`ValueError`.
* Widgets from :mod:`django.contrib.gis.forms.widgets` now render without
@@ -570,6 +570,9 @@ Miscellaneous
* The undocumented ``django.core.mail.forbid_multi_line_headers()`` and
``django.core.mail.message.sanitize_address()`` functions are deprecated.
+* The ``django.utils.crypto.constant_time_compare()`` function is deprecated
+ because it is merely an alias of :func:`hmac.compare_digest`.
+
Features removed in 6.0
=======================