aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWaylan Limberg <waylan.limberg@icloud.com>2014-12-23 00:21:57 -0500
committerWaylan Limberg <waylan.limberg@icloud.com>2014-12-23 00:21:57 -0500
commitfad98e502accac6a0aba27b4d15266b0554e9ad1 (patch)
treea474f31a087bd9eedfbff3100b321f4242144e52
parent99fe8e233035cc6b51e1e2746a00eb4e8447b177 (diff)
parenta76d958423d25a4e84e1d950a90055724762b1a7 (diff)
downloadmarkdown-fad98e502accac6a0aba27b4d15266b0554e9ad1.tar.gz
markdown-fad98e502accac6a0aba27b4d15266b0554e9ad1.tar.bz2
markdown-fad98e502accac6a0aba27b4d15266b0554e9ad1.zip
Merge pull request #378 from d0ugal/docs-fix
Correct the documentation for the slugify function
-rw-r--r--docs/extensions/toc.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/extensions/toc.txt b/docs/extensions/toc.txt
index 7b5d119..1d83df2 100644
--- a/docs/extensions/toc.txt
+++ b/docs/extensions/toc.txt
@@ -62,7 +62,7 @@ The following options are provided to configure the output:
>>> text = '''
# Header 1
-
+
## Header 2
'''
>>> md = markdown.Markdown(extensions=['markdown.extensions.toc'])
@@ -71,9 +71,10 @@ The following options are provided to configure the output:
* **`slugify`**:
Callable to generate anchors based on header text. Defaults to a built in
- `slugify` method. The callable must accept one argument which contains the
- text content of the header and return a string which will be used as the
- anchor text.
+ `slugify` method. The callable must accept two arguments, the first
+ contains the text content of the header and the second contains the
+ separator. It should then return a string which will be used as the anchor
+ text.
* **`title`**:
Title to insert in the Table of Contents' `<div>`. Defaults to `None`.