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