diff options
| author | Waylan Limberg <waylan@gmail.com> | 2014-08-29 22:18:10 -0400 |
|---|---|---|
| committer | Waylan Limberg <waylan@gmail.com> | 2014-08-29 22:18:10 -0400 |
| commit | 5f941454f9f7c8b62efec24917b2c7ba983d603c (patch) | |
| tree | f91ca2be452c6964d608b1e4d46b60d339e928ec /docs/release-2.5.txt | |
| parent | 3fda9d59fe0bd3a09c888ebadf92afffb2a74690 (diff) | |
| download | markdown-5f941454f9f7c8b62efec24917b2c7ba983d603c.tar.gz markdown-5f941454f9f7c8b62efec24917b2c7ba983d603c.tar.bz2 markdown-5f941454f9f7c8b62efec24917b2c7ba983d603c.zip | |
Some docs cleanup.
Diffstat (limited to 'docs/release-2.5.txt')
| -rw-r--r-- | docs/release-2.5.txt | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/docs/release-2.5.txt b/docs/release-2.5.txt index 4083383..044fcb2 100644 --- a/docs/release-2.5.txt +++ b/docs/release-2.5.txt @@ -29,31 +29,31 @@ Backwards-incompatible Changes instead, which provides more control of the output. [CodeHilite Extension]: extensions/code_hilite.html -[linenumes]: extensions/code_hilite.html#usage +[linenums]: 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, + 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 + 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']) + markdown.markdown(text, extensions=['extra']) - You should change your code to the following: + You should change your code to the following: - markdown.markdown(text, extensions=['markdown.extensions.extra']) + markdown.markdown(text, extensions=['markdown.extensions.extra']) - The same applies to the command line: + The same applies to the command line: - $ python -m markdown -x markdown.extensions.extra input.txt + $ python -m markdown -x markdown.extensions.extra input.txt - See the [documentation](reference.html#extensions) for a full explaination - of the current behavior. + 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 + 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. @@ -112,7 +112,7 @@ What's New in Python-Markdown 2.5 See the [API] documentation for a full explaination. [ec]: reference.html#extension_configs -[API]: extensions/api.txt#configsettings +[API]: extensions/api.html#configsettings * The [Command Line Interface][cli] now accepts a `--extensions_config` (or `-c`) option which accepts a filename and passes the parsed content of a [YAML] or @@ -126,6 +126,10 @@ What's New in Python-Markdown 2.5 [JSON]: http://json.org/ [PyYAML]: http://pyyaml.org/ +* The [amonition extension][ae] is no longer considered "experimental." + +[ae]: extensions/admonition.html + * There have been various refactors of the testing framework. While those changes will not directly effect end users, the code is being better tested which will benefit everyone. |