aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDougal Matthews <dougal@redhat.com>2014-12-22 17:51:25 +0000
committerDougal Matthews <dougal@redhat.com>2014-12-22 17:51:25 +0000
commita76d958423d25a4e84e1d950a90055724762b1a7 (patch)
treeb10f13058a9d2b3fa8faf00f70e808c03f46c8b6 /docs
parentc04d2c90fc741e2d1a612d25040b25252656b69c (diff)
downloadmarkdown-a76d958423d25a4e84e1d950a90055724762b1a7.tar.gz
markdown-a76d958423d25a4e84e1d950a90055724762b1a7.tar.bz2
markdown-a76d958423d25a4e84e1d950a90055724762b1a7.zip
Correct the documentation for the slugify function
The previous requirements are incorrect, the method needs to accept two parameters.
Diffstat (limited to 'docs')
-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`.