diff options
| author | Waylan Limberg <waylan@gmail.com> | 2014-08-29 20:00:39 -0400 |
|---|---|---|
| committer | Waylan Limberg <waylan@gmail.com> | 2014-08-29 20:00:39 -0400 |
| commit | 9a5b11116e2ea8a240fa2d03cad9de334023da9d (patch) | |
| tree | b40a5fcd3f65c22a891577cce28247d2355ddfa2 /docs/release-2.5.txt | |
| parent | e11a15531b5bd2d3ca2636e624ac377471b294e0 (diff) | |
| download | markdown-9a5b11116e2ea8a240fa2d03cad9de334023da9d.tar.gz markdown-9a5b11116e2ea8a240fa2d03cad9de334023da9d.tar.bz2 markdown-9a5b11116e2ea8a240fa2d03cad9de334023da9d.zip | |
Mark special treatment of extension names as PendingDeprecation
The builtin extensions will no longer get special treatment and have
the path ("markdown.extensions.") appended . The same applies for
"mdx_" extensions. All names extension must provide the full path.
Fixes #336.
Also deprecating support for passing in extension config settings
as part of the string name. The extension_configs keyword should
be used instead. Fixes #335.
Also raising PendingDeprecationWarnings for positional args or the
"config" keyword on the Extension Class. Pass each setting as a
seperate keyword instead.
Docs and tests are updated. Still need to update extension API docs.
Diffstat (limited to 'docs/release-2.5.txt')
| -rw-r--r-- | docs/release-2.5.txt | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/release-2.5.txt b/docs/release-2.5.txt index a81acfd..d45fe24 100644 --- a/docs/release-2.5.txt +++ b/docs/release-2.5.txt @@ -31,6 +31,33 @@ Backwards-incompatible Changes [CodeHilite Extension]: extensions/code_hilite.html [linenumes]: extensions/code_hilite.html#usage +* In previous versions of Python-Markdown, the builtin extensions received + special status and did not require the full path to be provided. Additionaly, + third party extensions whose name started with "mdx_" received the same + special treatment. This behavior will be deprecated in version 2.6 and will + raise a PendingDeprecationWarning in 2.5. Ensure that you always use the full + path to your extensions. For example, if you previously did the following: + + markdown.markdown(text, extensions=['extra']) + + You should change your code to the following: + + markdown.markdown(text, extensions=['markdown.extensions.extra']) + + The same applies to the command line: + + $ python -m markdown -x markdown.extensions.extra input.txt + + See the [documentation](reference.html#extensions) for a full explaination + of the current behavior. + +* The previously documented method of appending the extension configs as + a string to the extension name will be deprecated in Python-Markdown + version 2.6 and will raise a PendingDeprecationWarning in 2.5. The + [extension_configs](reference.html#extension_configs) keyword should + be used instead. See the [documentation](reference.html#extension-configs) + for a full explaination of the current behavior. + What's New in Python-Markdown 2.5 --------------------------------- |