diff options
| author | Mike Edmunds <medmunds@gmail.com> | 2025-02-14 10:58:01 -0800 |
|---|---|---|
| committer | Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> | 2025-03-21 10:17:57 +0100 |
| commit | e295033144e3085abaf9277d1bb0a6436ce73e01 (patch) | |
| tree | 582ec2ccaf6440a27c5bff5f6b73db2c8e5bd4ea /docs | |
| parent | aed303aff57ac990894b6354af001b0e8ea55f71 (diff) | |
Fixed #36138 -- Changed ADMINS and MANAGERS settings to lists of strings.
Previously, the ADMINS and MANAGERS settings were lists of (name, address)
tuples (where the name had been unused). Deprecated use of tuples.
Updated settings value sanity checks, and changed from ValueError to
ImproperlyConfigured.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 10 | ||||
| -rw-r--r-- | docs/internals/deprecation.txt | 3 | ||||
| -rw-r--r-- | docs/ref/settings.txt | 12 | ||||
| -rw-r--r-- | docs/releases/6.0.txt | 5 |
4 files changed, 19 insertions, 11 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 10b7edbca8..6aaf8bd0d9 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -606,15 +606,7 @@ example: Default: ``[]`` (Empty list) - A list of all the people who get code error notifications. When - ``DEBUG=False`` and a view raises an exception, Django will email these people - with the full exception information. Each member of the list should be a tuple - of (Full name, email address). Example:: - - [("John", "john@example.com"), ("Mary", "mary@example.com")] - - Note that Django will email *all* of these people whenever an error happens. - See :doc:`/howto/error-reporting` for more information. + A list of all the people who get code error notifications... This marks up the following header as the "canonical" target for the setting ``ADMINS``. This means any time I talk about ``ADMINS``, diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 1ac2c291e0..24831951a7 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -28,6 +28,9 @@ details on these changes. * The ``URLIZE_ASSUME_HTTPS`` transitional setting will be removed. +* Support for setting the ``ADMINS`` or ``MANAGERS`` settings to a list of + (name, address) tuples will be removed. + .. _deprecation-removed-in-6.1: 6.1 diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index ab82b539b0..e6fa3f4221 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -52,9 +52,13 @@ A list of all the people who get code error notifications. When is configured in :setting:`LOGGING` (done by default), Django emails these people the details of exceptions raised in the request/response cycle. -Each item in the list should be a tuple of (Full name, email address). Example:: +Each item in the list should be an email address string. Example:: - [("John", "john@example.com"), ("Mary", "mary@example.com")] + ADMINS = ["john@example.com", '"Ng, Mary" <mary@example.com>'] + +.. versionchanged:: 6.0 + + In older versions, required a list of (name, address) tuples. .. setting:: ALLOWED_HOSTS @@ -2074,6 +2078,10 @@ A list in the same format as :setting:`ADMINS` that specifies who should get broken link notifications when :class:`~django.middleware.common.BrokenLinkEmailsMiddleware` is enabled. +.. versionchanged:: 6.0 + + In older versions, required a list of (name, address) tuples. + .. setting:: MEDIA_ROOT ``MEDIA_ROOT`` diff --git a/docs/releases/6.0.txt b/docs/releases/6.0.txt index 2cbab2dace..f651274dfe 100644 --- a/docs/releases/6.0.txt +++ b/docs/releases/6.0.txt @@ -328,6 +328,11 @@ Miscellaneous * ``URLIZE_ASSUME_HTTPS`` transitional setting is deprecated. +* Setting :setting:`ADMINS` or :setting:`MANAGERS` to a list of (name, address) + tuples is deprecated. Set to a list of email address strings instead. Django + never used the name portion. To include a name, format the address string as + ``'"Name" <address>'`` or use Python's :func:`email.utils.formataddr`. + Features removed in 6.0 ======================= |
