Fewer backticks and bullets in upcoming-changes docs

(was hard to read with RTD's formatting)
This commit is contained in:
medmunds
2015-05-12 19:00:55 -07:00
parent 8db86a8274
commit 6798b72b8b

View File

@@ -16,50 +16,54 @@ version of Djrill (1.4) will try to warn you if you use things
that will change. (Warnings appear in the console when running Django that will change. (Warnings appear in the console when running Django
in debug mode.) in debug mode.)
* **Djrill Admin site**
Djrill 2.0 will remove the custom Djrill admin site. It duplicates **Djrill Admin site**
information from Mandrill's dashboard, most Djrill users are unaware
it exists, and it has caused problems tracking Django admin changes.
Drill 1.4 will report a `DeprecationWarning` when you try to load Djrill 2.0 will remove the custom Djrill admin site. It duplicates
the `DjrillAdminSite`. You should remove it from your code. information from Mandrill's dashboard, most Djrill users are unaware
it exists, and it has caused problems tracking Django admin changes.
Also, if you changed :setting:`INSTALLED_APPS` to use Drill 1.4 will report a DeprecationWarning when you try to load
`'django.contrib.admin.apps.SimpleAdminConfig'`, you may be able to the `DjrillAdminSite`. You should remove it from your code.
switch that back to `'django.contrib.admin'` and let Django
handle the `admin.autodiscover()` for you.
* **Dates in merge data and other attributes** Also, if you changed Django's :setting:`INSTALLED_APPS` setting to use
`'django.contrib.admin.apps.SimpleAdminConfig'`, you may be able to
switch that back to `'django.contrib.admin'` and let Django
handle the admin.autodiscover() for you.
Djrill automatically converts :attr:`send_at` `date` and `datetime`
values to the ISO 8601 string format expected by the Mandrill API.
Unintentionally, it also converts dates used in other Mandrill message **Dates in merge data and other attributes**
attributes (such as :attr:`merge_vars` or :attr:`metadata`) where it
might not be expected (or appropriate).
Djrill 2.0 will remove this automatic date formatting, except Djrill automatically converts :attr:`send_at` date and datetime
for attributes that are inherently dates (currently only `send_at`). values to the ISO 8601 string format expected by the Mandrill API.
To assist in detecting code relying on the (undocumented) current Unintentionally, it also converts dates used in other Mandrill message
behavior, Djrill 1.4 will report a `DeprecationWarning` for `date` attributes (such as :attr:`merge_vars` or :attr:`metadata`) where it
or `datetime` values used in any Mandrill message attributes other might not be expected (or appropriate).
than `send_at`. See :ref:`formatting-merge-data` for other options.
* **DjrillMessage class** Djrill 2.0 will remove this automatic date formatting, except
for attributes that are inherently dates (currently only `send_at`).
The ``DjrillMessage`` class has not been needed since Djrill 0.2. To assist in detecting code relying on the (undocumented) current
You can simply set Djrill message attributes on any Django behavior, Djrill 1.4 will report a DeprecationWarning for date
:class:`~django.core.mail.EmailMultiAlternatives` object. or datetime values used in any Mandrill message attributes other
Djrill 1.4 will report a `DeprecationWarning` if you are still than `send_at`. See :ref:`formatting-merge-data` for other options.
using ``DjrillMessage``.
* **DjrillBackendHTTPError**
The ``DjrillBackendHTTPError`` exception was replaced in Djrill 0.3 **DjrillMessage class**
with :exc:`djrill.MandrillAPIError`. Djrill 1.4 will report a
`DeprecationWarning` if you are still importing ``DjrillBackendHTTPError``. The ``DjrillMessage`` class has not been needed since Djrill 0.2.
You can simply set Djrill message attributes on any Django
:class:`~django.core.mail.EmailMessage` object.
Djrill 1.4 will report a DeprecationWarning if you are still
using DjrillMessage.
**DjrillBackendHTTPError**
The ``DjrillBackendHTTPError`` exception was replaced in Djrill 0.3
with :exc:`djrill.MandrillAPIError`. Djrill 1.4 will report a
DeprecationWarning if you are still importing DjrillBackendHTTPError.
Change Log Change Log