diff options
| author | Val Neekman <val@neekware.com> | 2019-07-27 22:39:01 -0400 |
|---|---|---|
| committer | Val Neekman <val@neekware.com> | 2019-07-27 22:39:01 -0400 |
| commit | b6067d10fc140d30d5d8860f28758e56faa59b4e (patch) | |
| tree | 2a980cf9c460cec9844fc4e739625bb9b2d75bca /slugify/slugify.py | |
| parent | a0cd8fd1608ff63b150bac9c6b32786a00bffc80 (diff) | |
| download | python-slugify-b6067d10fc140d30d5d8860f28758e56faa59b4e.tar.gz | |
update readme, add pydoc
Diffstat (limited to 'slugify/slugify.py')
| -rw-r--r-- | slugify/slugify.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/slugify/slugify.py b/slugify/slugify.py index fcd1d22..f9bd23d 100644 --- a/slugify/slugify.py +++ b/slugify/slugify.py @@ -80,11 +80,11 @@ def slugify(text, entities=True, decimal=True, hexadecimal=True, max_length=0, w """ Make a slug from the given text. :param text (str): initial text - :param entities (bool): - :param decimal (bool): - :param hexadecimal (bool): + :param entities (bool): converts html entities to unicode (foo & bar -> foo-bar) + :param decimal (bool): converts html decimal to unicode (Ž -> Ž -> z) + :param hexadecimal (bool): converts html hexadecimal to unicode (Ž -> Ž -> z) :param max_length (int): output string length - :param word_boundary (bool): + :param word_boundary (bool): truncates to complete word even if length ends up shorter than max_length :param save_order (bool): if parameter is True and max_length > 0 return whole words in the initial order :param separator (str): separator between words :param stopwords (iterable): words to discount |