From 4100336fba3a362ac45def3aa8e79e9af76eed7e Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Fri, 22 Aug 2014 11:57:48 -0400 Subject: Added `--extension_configs` option to the CLI. The `--extension_configs` option must point to a YAML or JSON file. The contents of the file must parse to a Python Dict which will be passed to the `extension_configs` keyword of the `markdown.Markdown` class. Also added tests for all of the CLI option parsing options and updated documentation. --- docs/release-2.5.txt | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) (limited to 'docs/release-2.5.txt') diff --git a/docs/release-2.5.txt b/docs/release-2.5.txt index 1ff0eff..4f8526f 100644 --- a/docs/release-2.5.txt +++ b/docs/release-2.5.txt @@ -20,14 +20,6 @@ Backwards-incompatible Changes What's New in Python-Markdown 2.5 --------------------------------- -* The Extension Configuration code has been refactord to make it a little easier -for extension authors to work with config settings. As a result, the -[extension_configs] keyword now accepts a dictionary rather than requiring -a list of tuples. A list of tuples is still supported so no one needs to change -their existing code. This should simplify the learning curve for new users. - -[extension_configs]: reference.html#extension_configs - * The [Smarty Extension] has had a number of additional configuration settings added, which allows one to define their own sustitutions to better support languages other than English. Thanks to [Martin Altmayer] for implementing this feature. @@ -35,8 +27,27 @@ languages other than English. Thanks to [Martin Altmayer] for implementing this [Smarty Extension]: extensions/smarty.html [Martin Altmayer]:https://github.com/MartinAltmayer -There have been various refactors of the testing framework. While those changes -will not directly effect end users, the code is being better tested whuch will +* The Extension Configuration code has been refactord to make it a little easier +for extension authors to work with config settings. As a result, the +[`extension_configs`][ec] keyword now accepts a dictionary rather than requiring +a list of tuples. A list of tuples is still supported so no one needs to change +their existing code. This should also simplify the learning curve for new users. + +[ec]: reference.html#extension_configs + +* 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 [JSON] file to the +[`extension_configs`][ec] keyword of the `markdown.Markdown` class. The conetents of +the YAML or JSON must map to a Python Dictionary which matches the format required +by the `extension_configs` kerword. Note that [PyYAML] is required to parse YAML files. + +[cli]: cli.html#using-extensions +[YAML]: http://yaml.org/ +[JSON]: http://json.org/ +[PyYAML]: http://pyyaml.org/ + +* 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. * Various bug fixes have been made. See the -- cgit v1.2.3