Skip to content

Commit 1a0dae5

Browse files
authored
[DOCS] Edit recent updates for clarity and Elastic style (#3194)
* [int]s not strings * Various cleanup
1 parent fa8fe72 commit 1a0dae5

File tree

3 files changed

+22
-20
lines changed

3 files changed

+22
-20
lines changed

docs/reference/dsl_tutorials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ for a in Article.esql_execute(query):
228228
print(a.title)
229229
```
230230

231-
Review the [ES|QL Query Builder section](esql-query-builder.md) to learn more about building ES|QL queries in Python.
231+
Review the [ES|QL query builder section](esql-query-builder.md) to learn more about building ES|QL queries in Python.
232232

233233
## Migration from the standard client [_migration_from_the_standard_client]
234234

docs/reference/esql-query-builder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# ES|QL Query Builder
1+
# ES|QL query builder
22

33
::::{warning}
44
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
55
::::
66

7-
The ES|QL Query Builder allows you to construct ES|QL queries using Python syntax. Consider the following example:
7+
The ES|QL query builder allows you to construct ES|QL queries using Python syntax. Consider the following example:
88

99
```python
1010
>>> from elasticsearch.esql import ESQL

docs/reference/index.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ mapped_pages:
77

88
# {{es}} Python client [overview]
99

10-
This documentation covers the [official Python client for {{es}}](https://github.com/elastic/elasticsearch-py). The goal of the Python client is to provide common ground for all {{es}}-related code in Python. The client is designed to be unopinionated and extendable.
10+
This documentation covers the [official Python client for {{es}}](https://github.com/elastic/elasticsearch-py). The Python client provides a comprehensive foundation for working with {{es}} in Python. The client is designed to be unopinionated and extensible.
1111

1212
## Example [_example]
1313

14+
Here's an example of basic Python client usage:
15+
1416
::::{tab-set}
1517

1618
:::{tab-item} Standard Python
@@ -26,8 +28,8 @@ def main():
2628

2729
resp = client.search(
2830
index="my-index-000001",
29-
from_="40",
30-
size="20",
31+
from_=40,
32+
size=20,
3133
query={
3234
"term": {
3335
"user.id": "kimchy"
@@ -51,8 +53,8 @@ async def main():
5153

5254
resp = await client.search(
5355
index="my-index-000001",
54-
from_="40",
55-
size="20",
56+
from_=40,
57+
size=20,
5658
query={
5759
"term": {
5860
"user.id": "kimchy"
@@ -67,19 +69,19 @@ async def main():
6769

6870
## Overview [_overview]
6971

70-
This package is composed of several modules:
72+
The {{es}} Python client package consists of several modules: the core client, a set of bulk helper functions, an ES|QL query builder, and a DSL module.
7173

72-
### The actual client
74+
### The core client
7375

74-
This module, sometimes also called the "low-level" client, implements the support for sending requests to {{es}} servers. The client provides access to the entire surface of the {{es}} API.
76+
This module, also known as the low-level client, enables sending requests to {{es}} servers. The client provides access to the entire surface of the {{es}} API.
7577

76-
* [Getting Started guide](getting-started.md)
77-
* [Ingest data with Python walkthrough](docs-content://manage-data/ingest/ingesting-data-from-applications/ingest-data-with-python-on-elasticsearch-service.md)
78+
* [](getting-started.md)
79+
* [Walkthrough: Ingest data with Python](docs-content://manage-data/ingest/ingesting-data-from-applications/ingest-data-with-python-on-elasticsearch-service.md)
7880
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/es_api.html)
7981

8082
#### Features [_features]
8183

82-
The client's features include:
84+
The core client's features include:
8385

8486
* Translating basic Python data types to and from JSON
8587
* Configurable automatic discovery of cluster nodes
@@ -91,23 +93,23 @@ The client's features include:
9193

9294
### Bulk helpers
9395

94-
The bulk helpers are a set of functions that simplify the ingest of large amounts of data through a high-level interface based on Python iterables.
96+
The bulk helpers simplify ingesting large amounts of data, by providing a high-level interface based on Python iterables.
9597

96-
* [User guide](client-helpers.md#bulk-helpers)
98+
* [](client-helpers.md#bulk-helpers)
9799
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/api_helpers.html)
98100

99101
### ES|QL query builder
100102

101-
This module offers an idiomatic interface to construct ES|QL queries using Python expressions.
103+
The ES|QL query builder offers an idiomatic interface for constructing ES|QL queries using Python expressions.
102104

103-
* [User guide](esql-query-builder.md)
105+
* [](esql-query-builder.md)
104106
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/esql.html)
105107

106108
### DSL module
107109

108-
The DSL module could be thought of as a "high-level" client for {{es}}. It allows applications to manipulate documents and queries using Python classes and objects instead of primitive types such as dictionaries and lists.
110+
The DSL module can be thought of as a high-level client for {{es}}. It allows applications to manipulate documents and queries using Python classes and objects, instead of primitive types such as dictionaries and lists.
109111

110-
* [User guide](elasticsearch-dsl.md)
112+
* [](elasticsearch-dsl.md)
111113
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/dsl.html)
112114

113115
## Compatibility [_compatibility]

0 commit comments

Comments
 (0)