Skip to content

[Backport 9.0] [docs] Add param notes to DSL search.delete documentation, fix broken links #2869

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.

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

Merged
merged 1 commit into from
Apr 1, 2025

Conversation

github-actions[bot]
Copy link

Backport b6d1211 from #2861.

… links (#2861)

* Add param notes to DSL search.delete documentation, fix broken links

The preferred way of passing parameters to the DSL `Search.delete` appears to be calling `Search.params` first,
but this is only ever discussed in GitHub issues like
elastic/elasticsearch-dsl-py#1115
and elastic/elasticsearch-dsl-py#1395.

To help anyone else who has stumbled across this, I added a note about this to the documentation.

I also went ahead and updated the links for the `Search.scan` and `FacetedSearch.params`
methods to the most recent versions since they were 404ing.

* make sync and async changes the same

---------

Co-authored-by: Luna Lucadou <[email protected]>
Co-authored-by: Miguel Grinberg <[email protected]>
(cherry picked from commit b6d1211)
@miguelgrinberg miguelgrinberg merged commit 01893c8 into 9.0 Apr 1, 2025
15 checks passed
@miguelgrinberg miguelgrinberg deleted the backport-2861-to-9.0 branch April 1, 2025 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants