Skip to content
This repository was archived by the owner on Dec 17, 2019. It is now read-only.

Commit fad98e5

Browse files
committed
Merge pull request Python-Markdown#378 from d0ugal/docs-fix
Correct the documentation for the slugify function
2 parents 99fe8e2 + a76d958 commit fad98e5

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/extensions/toc.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The following options are provided to configure the output:
6262

6363
>>> text = '''
6464
# Header 1
65-
65+
6666
## Header 2
6767
'''
6868
>>> md = markdown.Markdown(extensions=['markdown.extensions.toc'])
@@ -71,9 +71,10 @@ The following options are provided to configure the output:
7171

7272
* **`slugify`**:
7373
Callable to generate anchors based on header text. Defaults to a built in
74-
`slugify` method. The callable must accept one argument which contains the
75-
text content of the header and return a string which will be used as the
76-
anchor text.
74+
`slugify` method. The callable must accept two arguments, the first
75+
contains the text content of the header and the second contains the
76+
separator. It should then return a string which will be used as the anchor
77+
text.
7778

7879
* **`title`**:
7980
Title to insert in the Table of Contents' `<div>`. Defaults to `None`.

0 commit comments

Comments
 (0)