diff --git a/clp_ffi_py/wildcard_query.py b/clp_ffi_py/wildcard_query.py index 13eb3d4d..64c34772 100644 --- a/clp_ffi_py/wildcard_query.py +++ b/clp_ffi_py/wildcard_query.py @@ -62,8 +62,8 @@ def case_sensitive(self) -> bool: class SubstringWildcardQuery(WildcardQuery): """ A wildcard query that can match a substring in a log event's message, in - contrast with :class:`FullStringWildcardQuery` where the needs to match the - entire message. + contrast with :class:`FullStringWildcardQuery` where the query needs to + match the entire message. This class is derived from :class:`WildcardQuery` by adding both a prefix and a postfix wildcard ("*") to the input wildcard string. diff --git a/docs/src/api/clp_ffi_py.ir.query_builder.rst b/docs/src/api/clp_ffi_py.ir.query_builder.rst index 999be5d6..85ab2632 100644 --- a/docs/src/api/clp_ffi_py.ir.query_builder.rst +++ b/docs/src/api/clp_ffi_py.ir.query_builder.rst @@ -29,9 +29,10 @@ clp\_ffi\_py.ir.query\_builder module query list. .. deprecated:: 0.0.12 - Instead, use :meth:`add_wildcard_query` with either a + Use :meth:`add_wildcard_query` with either a :class:`~clp_ffi_py.wildcard_query.FullStringWildcardQuery` or - :class:`~clp_ffi_py.wildcard_query.SubstringWildcardQuery`. + :class:`~clp_ffi_py.wildcard_query.SubstringWildcardQuery` + instead. :param str wildcard_query: The wildcard query string to add. :param bool case_sensitive: Whether to perform case-sensitive matching.