diff --git a/changelog.md b/changelog.md index a1f3d65..badad11 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,9 @@ # Changelog +## 1.3.1 + +- **FIX**: Better deprecation warning. + ## 1.3 - **NEW**: The final release. `mkdocs-material` (version 9.4) now has this library's logic built-in making this library diff --git a/materialx/__meta__.py b/materialx/__meta__.py index 7320b13..d8e1bc6 100644 --- a/materialx/__meta__.py +++ b/materialx/__meta__.py @@ -188,5 +188,5 @@ def parse_version(ver): return Version(major, minor, micro, release, pre, post, dev) -__version_info__ = Version(1, 3, 0, "final") +__version_info__ = Version(1, 3, 1, "final") __version__ = __version_info__._get_canonical() diff --git a/materialx/emoji.py b/materialx/emoji.py index 6b0a4d3..c0ceb71 100644 --- a/materialx/emoji.py +++ b/materialx/emoji.py @@ -22,7 +22,16 @@ DEPRECATED = """\ Material emoji logic has been officially moved into mkdocs-material version 9.4. Please use Material's '{}' -as mkdocs_material_extensions is deprecated and will no longer be +instead of '{}' in your 'mkdocs.yml' file. + +``` +markdown_extensions: + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg +``` + +'mkdocs_material_extensions' is deprecated and will no longer be supported moving forward. This is the last release. """ @@ -68,7 +77,10 @@ def _deprecated_func(*args, **kwargs): return _wrapper -@deprecated(DEPRECATED.format('material.extensions.emoji.twemoji'), name='materialx.emoji.twemoji') +@deprecated( + DEPRECATED.format('material.extensions.emoji.twemoji', 'materialx.emoji.twemoji'), + name='materialx.emoji.twemoji' +) def _patch_index(options): """Patch the given index.""" @@ -112,7 +124,11 @@ def twemoji(): return _patch_index({}) -@deprecated(DEPRECATED.format('material.extensions.emoji.to_svg'), 1, name='materialx.emoji.to_svg') +@deprecated( + DEPRECATED.format('material.extensions.emoji.to_svg', 'materialx.emoji.to_svg'), + 1, + name='materialx.emoji.to_svg' +) def to_svg(index, shortname, alias, uc, alt, title, category, options, md): """Return SVG element."""