aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2013-05-09 23:53:01 -0300
committerWaylan Limberg <waylan@gmail.com>2013-05-09 23:53:01 -0300
commit49cc78a98050ee07909b57cfd4c8135276c7cecc (patch)
treeac29ab21e880cac2c58bb49943f1d9837ea8dfc8
parent9d8ae38136ee334f490887e3cf1f44d36603cf55 (diff)
downloadmarkdown-49cc78a98050ee07909b57cfd4c8135276c7cecc.tar.gz
markdown-49cc78a98050ee07909b57cfd4c8135276c7cecc.tar.bz2
markdown-49cc78a98050ee07909b57cfd4c8135276c7cecc.zip
Updated extension API docs to list output_format and serializer on the md instance.
I still need to document everything on that list and probably a few things missing from the list. I also updated the warning about monkey patching to be a "Warning" admonition - now that we have that extension. Probably should depreciate access to md_globals in the extension API -- as we don't actually use any anymore. That dates back to pre-OO code.
-rw-r--r--docs/extensions/api.txt15
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/extensions/api.txt b/docs/extensions/api.txt
index bc06154..74f0bcf 100644
--- a/docs/extensions/api.txt
+++ b/docs/extensions/api.txt
@@ -396,6 +396,8 @@ accepts two arguments:
* ``md.htmlStash``
* ``md.output_formats``
* ``md.set_output_format()``
+ * ``md.output_format``
+ * ``md.serializer``
* ``md.registerExtension()``
* ``md.html_replacement_text``
* ``md.tab_length``
@@ -406,12 +408,13 @@ accepts two arguments:
Contains all the various global variables within the markdown module.
-Of course, with access to those items, theoretically you have the option to
-changing anything through various [monkey_patching][] techniques. However, you
-should be aware that the various undocumented or private parts of markdown
-may change without notice and your monkey_patches may break with a new release.
-Therefore, what you really should be doing is inserting processors and patterns
-into the markdown pipeline. Consider yourself warned.
+!!! Warning
+ With access to the above items, theoretically you have the option to
+ change anything through various [monkey_patching][] techniques. However,
+ you should be aware that the various undocumented parts of markdown may
+ change without notice and your monkey_patches may break with a new release.
+ Therefore, what you really should be doing is inserting processors and
+ patterns into the markdown pipeline. Consider yourself warned!
[monkey_patching]: http://en.wikipedia.org/wiki/Monkey_patch