Allow, block regex parameter name inconsistency
panabar opened this issue · 0 comments
panabar commented
Hi @asweigart,
Thank you for the python books and this module. While trying pyinputplus.inputStr() while reading the readme.md I noticed the following inconsistency.
The readme file states:
whitelistRegexes (Sequence, None): A sequence of regex str that will explicitly pass validation, even if they aren't numbers. Defaults to None
blacklistRegexes (Sequence, None): A sequence of regex str or (regex_str, response_str) tuples that, if matched, will explicitly fail validation. Defaults to None.
The parameters() function in init.py
def parameters():
"""
Common parameters for all ``input*()`` functions in PyInputPlus:
...
* ``allowlistRegexes`` (Sequence, None): A sequence of regex str that will explicitly pass validation.
* ``blocklistRegexes`` (Sequence, None): A sequence of regex str or ``(regex_str, error_msg_str)`` tuples that, if matched, will explicitly fail validation.
...
"""
However, the named parameters in the actual functions are allowRegexes
and blockRegexes
.