diff options
| author | Reza Moradi <mrezzamoradi@gmail.com> | 2022-02-16 23:36:00 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-16 17:36:00 -0500 |
| commit | dce218991ddf16d916501fb6f72980f9ca0c892a (patch) | |
| tree | f3e4ae6a9b204515c894e92417ee2dc6da9ca5d7 /README.md | |
| parent | b2aaccd0b0e8ac4780ff29221d7d0fe915aa3f0d (diff) | |
| download | python-slugify-dce218991ddf16d916501fb6f72980f9ca0c892a.tar.gz | |
Fix misleading pattern name and documentation (#109)
* Add better typing for slugify.slugify
Currently, mypy understands the type as `Iterable[str]`, which doesn't match what should actually be passed in, which is `Iterable[Iterable[str]]` or, ideally, `Iterable[Tuple[str, str]]`
* whitespace around =
* fix misleading pattern name and documentation
* fix README.md and cli doc as well
Co-authored-by: Fahrzin Hemmati <fahhem@users.noreply.github.com>
Co-authored-by: Val Neekman (AvidCoder) <un33kvu@gmail.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -55,7 +55,7 @@ def slugify( :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 - :param regex_pattern (str): regex pattern for allowed characters + :param regex_pattern (str): regex pattern for disallowed characters :param lowercase (bool): activate case sensitivity by setting it to False :param replacements (iterable): list of replacement rules e.g. [['|', 'or'], ['%', 'percent']] :return (str): slugify text |