Skip to content

Commit 5983fb2

Browse files
Docstring fixes
1 parent 78e50df commit 5983fb2

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

elasticsearch/esql/esql.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,9 @@ def branch() -> "Branch":
9292

9393

9494
class ESQLBase(ABC):
95-
""" """
95+
"""The methods of the ``ESQLBase`` class provide access to the ES|QL processing
96+
commands, used to build ES|QL queries.
97+
"""
9698

9799
def __init__(self, parent: Optional["ESQLBase"] = None):
98100
self._parent = parent

elasticsearch/esql/functions.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,7 @@ def match(
544544
545545
:param field: Field that the query will target.
546546
:param query: Value to find in the provided field.
547-
:param options: (Optional) Match additional options as [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params).
547+
:param options: (Optional) Match additional options as function named parameters.
548548
"""
549549
if options is not None:
550550
return InstrumentedExpression(
@@ -1188,8 +1188,8 @@ def st_geohash(
11881188
:param precision: Expression of type `integer`. If `null`, the function
11891189
returns `null`. Valid values are between 1 and 12.
11901190
:param bounds: Optional bounds to filter the grid tiles, a `geo_shape` of
1191-
type `BBOX`. Use [`ST_ENVELOPE`](#esql-st_envelope) if the
1192-
`geo_shape` is of any other type.
1191+
type `BBOX`. Use `ST_ENVELOPE` if the `geo_shape` is of any
1192+
other type.
11931193
"""
11941194
if bounds is not None:
11951195
return InstrumentedExpression(
@@ -1234,7 +1234,7 @@ def st_geohex(
12341234
:param precision: Expression of type `integer`. If `null`, the function
12351235
returns `null`. Valid values are between 0 and 15.
12361236
:param bounds: Optional bounds to filter the grid tiles, a `geo_shape` of
1237-
type `BBOX`. Use [`ST_ENVELOPE`](#esql-st_envelope) if the `geo_shape`
1237+
type `BBOX`. Use `ST_ENVELOPE` if the `geo_shape`
12381238
is of any other type.
12391239
"""
12401240
if bounds is not None:
@@ -1280,8 +1280,8 @@ def st_geotile(
12801280
:param precision: Expression of type `integer`. If `null`, the function
12811281
returns `null`. Valid values are between 0 and 29.
12821282
:param bounds: Optional bounds to filter the grid tiles, a `geo_shape` of
1283-
type `BBOX`. Use [`ST_ENVELOPE`](#esql-st_envelope) if the
1284-
`geo_shape` is of any other type.
1283+
type `BBOX`. Use `ST_ENVELOPE` if the `geo_shape` is of any
1284+
other type.
12851285
"""
12861286
if bounds is not None:
12871287
return InstrumentedExpression(

0 commit comments

Comments
 (0)