Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use class-based queries and type-hinted documents in DSL documentation examples #2857

Merged
merged 2 commits into from
Mar 28, 2025
Merged

Use class-based queries and type-hinted documents in DSL documentation examples #2857

merged 2 commits into from
Mar 28, 2025
+189 −131

Conversation

miguelgrinberg
Copy link
Contributor

@miguelgrinberg miguelgrinberg commented Mar 24, 2025 •
edited
Loading

This change updates code blocks in DSL documentation to use the coding style introduced in recent releases based on query and aggregation classes and type hints for document definition. There is also some minor fixes/improvements, such as the addition of a few docstrings to methods of the Search class, and a new section on migrating from the elasticsearch-dsl package.

@miguelgrinberg
Use class-based queries and type-hinted documents in DSL documentatio…

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
Loading
Loading status checks…
1a7d83f 
…n examples
@miguelgrinberg miguelgrinberg force-pushed the dsl-docs-improvements branch 2 times, most recently from 468d9ae to 7362c63 Compare March 26, 2025 12:20
@miguelgrinberg
DSL migrating section
Loading
Loading status checks…
8aa969c
@miguelgrinberg miguelgrinberg force-pushed the dsl-docs-improvements branch from 7362c63 to 8aa969c Compare March 26, 2025 12:40
@miguelgrinberg miguelgrinberg requested a review from pquentin March 26, 2025 12:40
@miguelgrinberg miguelgrinberg marked this pull request as ready for review March 26, 2025 12:40
pquentin
pquentin approved these changes Mar 28, 2025
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM. Excellent work. Sorry for the reviewing delay.

@miguelgrinberg miguelgrinberg merged commit d492524 into elastic:main Mar 28, 2025
14 checks passed
@miguelgrinberg miguelgrinberg deleted the dsl-docs-improvements branch March 28, 2025 14:24
github-actions bot pushed a commit that referenced this pull request Mar 28, 2025
@miguelgrinberg @github-actions
Use class-based queries and type-hinted documents in DSL documentatio…
Loading
Loading status checks…
5918761 
…n examples (#2857)

* Use class-based queries and type-hinted documents in DSL documentation examples

* DSL migrating section

(cherry picked from commit d492524)
@github-actions github-actions bot mentioned this pull request Mar 28, 2025
Merged
miguelgrinberg added a commit that referenced this pull request Mar 28, 2025
@github-actions @miguelgrinberg
Use class-based queries and type-hinted documents in DSL documentatio…
Loading
Loading status checks…
cb1c14f 
…n examples (#2857) (#2862)

* Use class-based queries and type-hinted documents in DSL documentation examples

* DSL migrating section

(cherry picked from commit d492524)

Co-authored-by: Miguel Grinberg <miguel.grinberg@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pquentin pquentin

Assignees
No one assigned
Labels
backport 9.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@miguelgrinberg @pquentin