aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release-2.4.txt
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2013-08-13 13:17:05 -0400
committerWaylan Limberg <waylan@gmail.com>2013-08-13 13:17:05 -0400
commitdf657a917a6ad9c79ee5bf9e4a109282ed905c2a (patch)
tree3291d461bdc8bf669e03a5ea5b6eaaa3cae0b7e7 /docs/release-2.4.txt
parentd1541a58118c0968a0572e36d1956b866c95b534 (diff)
downloadmarkdown-df657a917a6ad9c79ee5bf9e4a109282ed905c2a.tar.gz
markdown-df657a917a6ad9c79ee5bf9e4a109282ed905c2a.tar.bz2
markdown-df657a917a6ad9c79ee5bf9e4a109282ed905c2a.zip
Added release notes for pending release of v2.4.
Since adding the new smarty extension, the nex release it more than just a bugfix release.
Diffstat (limited to 'docs/release-2.4.txt')
-rw-r--r--docs/release-2.4.txt44
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/release-2.4.txt b/docs/release-2.4.txt
new file mode 100644
index 0000000..78b78be
--- /dev/null
+++ b/docs/release-2.4.txt
@@ -0,0 +1,44 @@
+title: Release Notes for v2.4
+prev_title: Change Log
+prev_url: change_log.html
+next_title: Release Notes for v2.3
+next_url: release-2.3.html
+
+Python-Markdown 2.4 Release Notes
+=================================
+
+We are pleased to release Python-Markdown 2.4 which adds one new extension
+and fixes various bugs. See the list of changes below for details.
+
+Python-Markdown supports Python versions 2.6, 2.7, 3.1, 3.2, and 3.3.
+
+Backwards-incompatible Changes
+------------------------------
+
+* The "force_linenos" config setting of the CodeHilite extension has been
+marked as **Deprecated**. It had previously been marked as "Pending Deprecation"
+in version 2.3 when a new setting "linenums" was added to 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 "force_linenos" will raise a DeprecationWarning and will likely
+be removed in a future version of Python-Markdown.
+
+[CodeHilite Extension]: extensions/codehilite.html
+
+What's New in Python-Markdown 2.4
+---------------------------------
+
+* Thanks to the hard work of [Dmitry Shachnev] the [Smarty Extension] has been
+added, which implements [SmartyPants] using Python-Markdown's Extension API.
+This offers a few benefits over a third party sript. The HTML does not need
+to be "tokenized" twice, no hacks are required to combine SmartyPants and
+code highlighting, and we get markdown's escaping feature for free. Please try
+it out and report bugs and/or improvements.
+
+[Dmitry Shachnev]: https://github.com/mitya57
+[Smarty Extension]: extensions/smarty.html
+[SmartyPants]: http://daringfireball.net/projects/smartypants/
+
+* Various bug fixes have been made. See the
+[commit log](https://github.com/waylan/Python-Markdown/commits/master)
+for a complete history of the changes.