docs(api): indicate that re_search need only match part of a string (#10402)

Author: NickCrews

ibis/expr/types/strings.py

@@ -1020,9 +1020,9 @@ def ilike(
         why="Different backends support different regular expression syntax."
     )
     def re_search(self, pattern: str | StringValue) -> ir.BooleanValue:
-        """Return whether the values match `pattern`.
+        """Return whether `self` contains the regex `pattern`.
 
-        Returns `True` if the regex matches a string and `False` otherwise.
+        Returns `True` if the regex matches any part of a string and `False` otherwise.
 
         Parameters
         ----------
@@ -1038,7 +1038,7 @@ def re_search(self, pattern: str | StringValue) -> ir.BooleanValue:
         --------
         >>> import ibis
         >>> ibis.options.interactive = True
-        >>> t = ibis.memtable({"s": ["Ibis project", "GitHub"]})
+        >>> t = ibis.memtable({"s": ["Ibis project", "GitHub", "GitHub Actions"]})
         >>> t.s.re_search(".+Hub")
         ┏━━━━━━━━━━━━━━━━━━━━━━━━━┓
         ┃ RegexSearch(s, '.+Hub') ┃
@@ -1047,6 +1047,7 @@ def re_search(self, pattern: str | StringValue) -> ir.BooleanValue:
         ├─────────────────────────┤
         │ False                   │
         │ True                    │
+        │ True                    │
         └─────────────────────────┘
         """
         return ops.RegexSearch(self, pattern).to_expr()