From a76d958423d25a4e84e1d950a90055724762b1a7 Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Mon, 22 Dec 2014 17:51:25 +0000 Subject: Correct the documentation for the slugify function The previous requirements are incorrect, the method needs to accept two parameters. --- docs/extensions/toc.txt | 9 +++++---- 1 file 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' `
`. Defaults to `None`. -- cgit v1.2.3