Add docstrings to the Text filter

This commit is contained in:
birdi 2019-08-05 10:02:06 +03:00
parent e4b0c2a3df
commit 321aa404c3

View file

@ -213,11 +213,12 @@ class Text(Filter):
ignore_case=False):
"""
Check text for one of pattern. Only one mode can be used in one filter.
In every pattern, a single string is treated as a list with 1 element.
:param equals:
:param contains:
:param startswith:
:param endswith:
:param equals: True if object text in the list
:param contains: True if object text contains all strings from the list
:param startswith: True if object text startswith any of strings from the list
:param endswith: True if object text endswith any of strings from the list
:param ignore_case: case insensitive
"""
# Only one mode can be used. check it.