From 8dce6643d04f449d0180b1233cf4b653420563e0 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 27 Feb 2013 05:29:04 -0500 Subject: Updated release notes for v2.3. to reflect recent changes. --- docs/release-2.3.txt | 46 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 14 deletions(-) (limited to 'docs/release-2.3.txt') diff --git a/docs/release-2.3.txt b/docs/release-2.3.txt index e8a6257..052fb23 100644 --- a/docs/release-2.3.txt +++ b/docs/release-2.3.txt @@ -7,15 +7,24 @@ next_url: release-2.2.1.html Python-Markdown 2.3 Release Notes ================================= -We are pleased to release Python-Markdown 2.3 which ... +We are pleased to release Python-Markdown 2.3 which adds one new extension, +remove an old extension, and now runs on both Python 2 and Python 3 +without running the 2to3 conversion tool. See the list of changes below for +details. -Python-Markdown supports Python versions 2.6, 2.7, 3.1, 3.3, and 3.3. +Python-Markdown supports Python versions 2.6, 2.7, 3.1, 3.2, and 3.3. Backwards-incompatible Changes ------------------------------ * Support has been dropped for Python 2.5. No guarantees are made that the -library will work in any version of Python lower than 2.6. +library will work in any version of Python lower than 2.6. As all supported +Python versions include the ElementTree library, Python-Markdown no longer +will try to import a third-party installation of ElementTree. + +* All classes are now "new-style" classes. In other words, all classes +subclass from 'object'. While this is not likely to affect most users, +extension authors may need to make a few minor adjustments to their code. * "safe_mode" has been further restricted. Markdown formated links must be of a known whitelisted scheme when in "safe_mode" or the url is discarded. @@ -31,26 +40,35 @@ you are outputing XHTML (the default) or HTML4. * The "force_linenos" config setting of the CodeHilite extension has been marked as Pending Deprecation and a new setting "linenums" has been added to -replace it. See documentation for the [CodeHilite Extension] for an explaination -of the new "linenums" setting. The new setting will honor the old "force_linenos" -if it is set, but it will raise a PendingDeprecationWarning and will likely be -removed in a future version of Python-Markdown. +replace it. See documentation for the [CodeHilite Extension] for an explanation +of the new "linenums" setting. The new setting will honor the old +"force_linenos" if it is set, but it will raise a PendingDeprecationWarning +and will likely be removed in a future version of Python-Markdown. [CodeHilite Extension]: extensions/codehilite.html * The "RSS" extension has been removed and no longer ships with Python-Markdown. -If you would like to continue using the extension (not recomended), it is archived -on [Github](https://gist.github.com/waylan/4773365). +If you would like to continue using the extension (not recomended), it is +archived on [Github](https://gist.github.com/waylan/4773365). What's New in Python-Markdown 2.3 --------------------------------- -Added the [Adminition Extension] which implements [rST-style][rST] admonitions -to the Markdown syntax. However, be warned that this extension is experimental -and the syntax and behavior is still subject to change. Please try it out and -report bugs/improvements. +* The entire code base now universally runs in Python 2 and Python 3 without +any need for running the 2to3 conversion tool. This not only simplifies testing, +but by using unicode_literals, results in more consistent behavior across +Python versions. Additionally, the relative imports (made possible in Python 2 +via absolute_import) allows the entire library to more easily be embedded in a +subdirectory of another project. The various files within the library will +still import each other properly even though 'markdown' may not be in Python's +root namespace. + +* Added the [Admonition Extension] which implements [rST-style][rST] +admonitions to the Markdown syntax. However, be warned that this extension +is experimental and the syntax and behavior is still subject to change. Please +try it out and report bugs/improvements. -[Adminition Extension]: extensions/adminition.html +[Admonition Extension]: extensions/admonition.html [rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions Various bug fixes have been made. See the -- cgit v1.2.3