summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfacelessuser <faceless.shop@gmail.com>2017-11-17 18:26:57 -0700
committerfacelessuser <faceless.shop@gmail.com>2017-11-17 18:26:57 -0700
commit33503757713c437caa9d521713585acb358f652d (patch)
tree736ed58efd9ab9329b2dedb88a1f70e6446fa524
parentd105848ae0631cd45c5e3d31c3e09224b8490858 (diff)
downloadpython-markdown-33503757713c437caa9d521713585acb358f652d.tar.gz
Document new getExcludes method
Document the new getExcludes method.
-rw-r--r--docs/extensions/api.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/extensions/api.txt b/docs/extensions/api.txt
index 9653883..d2d0cca 100644
--- a/docs/extensions/api.txt
+++ b/docs/extensions/api.txt
@@ -68,6 +68,12 @@ must have the following methods:
Accepts a match object and returns an ElementTree element of a plain
Unicode string.
+* **`getExcludes()`**:
+
+ Returns an array of tag names that are undesirable ancestors. The pattern
+ should not match if it would cause the content to be a decendent of one
+ of the tag names in the list.
+
Note that any regular expression returned by `getCompiledRegExp` must capture
the whole block. Therefore, they should all start with `r'^(.*?)'` and end
with `r'(.*?)!'`. When using the default `getCompiledRegExp()` method