Skip to content

Commit

Permalink
Remove the deprecated simple_history_admin_list.display_list() + **…
Browse files Browse the repository at this point in the history
…Release 3.9.0** (#1444)

* Removed the deprecated simple_history_admin_list

This was deprecated in 16b7de7.

* Updated release notes for removing display_list()
  • Loading branch information
ddabble authored Jan 26, 2025
1 parent 389a3a4 commit 55850c2
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 24 deletions.
9 changes: 9 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ Changes
Unreleased
----------


3.9.0 (2025-01-26)
------------------

- Removed the ``simple_history_admin_list.display_list()`` template tag that was
deprecated in version 3.6.0 (gh-1444)

3.8.0 (2025-01-23)
------------------

Expand All @@ -19,6 +26,8 @@ Unreleased
- Fixed issue with history button not working when viewing historical entries in the
admin (gh-527)
- Added support for Django 5.2 (gh-1441)
- ``simple_history_admin_list.display_list()`` *was planned to be removed in this
release, but it was overlooked, and will instead be removed in 3.9.0*

3.7.0 (2024-05-29)
------------------
Expand Down
15 changes: 0 additions & 15 deletions simple_history/templatetags/simple_history_admin_list.py

This file was deleted.

15 changes: 6 additions & 9 deletions simple_history/tests/tests/test_deprecation.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import unittest

from simple_history import __version__
from simple_history.templatetags.simple_history_admin_list import display_list


class DeprecationWarningTest(unittest.TestCase):
def test__display_list__warns_deprecation_and_is_yet_to_be_removed(self):
with self.assertWarns(DeprecationWarning):
display_list({})
# DEV: `display_list()` (and the file `simple_history_admin_list.py`) should be
# removed when 3.8 is released
self.assertLess(__version__, "3.8")
"""Tests that check whether ``DeprecationWarning`` is raised for certain features,
and that compare ``simple_history.__version__`` against the version the features
will be removed in.
If this class is empty, it normally means that nothing is currently deprecated.
"""

0 comments on commit 55850c2

Please sign in to comment.