Skip to content

Commit

Permalink
Updated extension API docs to list output_format and serializer on th…
Browse files Browse the repository at this point in the history
…e 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.
  • Loading branch information
Waylan Limberg committed May 10, 2013
1 parent 9d8ae38 commit 49cc78a
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions docs/extensions/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand All @@ -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

Expand Down

0 comments on commit 49cc78a

Please sign in to comment.