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/cli.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/cli.txt')
| -rw-r--r-- | docs/cli.txt | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/docs/cli.txt b/docs/cli.txt index acad4ff..7741d34 100644 --- a/docs/cli.txt +++ b/docs/cli.txt @@ -147,17 +147,14 @@ The `--extension_configs` option will only support YAML config files if [PyYaml] installed on your system. JSON should work with no additional dependencies. The format of your config file is automatically detected. -As an alternative, you may append the extension configs as a string to the extension name -that is provided to the `-x-` option in the following format: - - $ python -m markdown -x "markdown.extensions.footnotes(PLACE_MARKER=~~~~~~~~,UNIQUE_IDS=1)" input.txt - -Note that there are no quotes or whitespace in the above format, which severely limits -how it can be used. For more complex settings, it is suggested that the -`--extension_configs` option be used. +!!!warning + 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. The `--extension_configs` + option should be used instead. See the [2.5 release notes] for more information. [ec]: reference.html#extension_configs [YAML]: http://yaml.org/ [JSON]: http://json.org/ [PyYAML]: http://pyyaml.org/ +[2.5 release notes]: release-2.5.txt |