[docs] Add param notes to DSL search.delete documentation, fix broken links #2861
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.
| 💚 CLA has been signed |
| I have signed the CLA. |
miguelgrinberg approved these changes Mar 31, 2025
github-actions bot pushed a commit that referenced this pull request Mar 31, 2025
… 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 <LUNA.LUCADOU@users.noreply.git.doit.wisc.edu> Co-authored-by: Miguel Grinberg <miguel.grinberg@gmail.com> (cherry picked from commit b6d1211)
| Thanks @lunalucadou ! |
miguelgrinberg pushed a commit that referenced this pull request Apr 1, 2025
… links (#2861) (#2869) * 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 <LUNA.LUCADOU@users.noreply.git.doit.wisc.edu> Co-authored-by: Miguel Grinberg <miguel.grinberg@gmail.com> (cherry picked from commit b6d1211) Co-authored-by: Luna Lucadou <22415965+lunalucadou@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
This MR was previously opened against the DSL project but I was told I should submit it here instead: elastic/elasticsearch-dsl-py#1970
Earlier today I was trying to pass
wait_for_completion=TruetoSearch.deletebut foundSearch.deletedoes not support**kwargs.I was going to just add support for
**kwargs(it would be a fairly trivial change), but after seeing elastic/elasticsearch-dsl-py#1115 and elastic/elasticsearch-dsl-py#1395, it seems the preferred way is to callSearch.paramsfirst. However, this is not called out in the documentation forSearch.delete, so I instead opted to add it to the documentation.While I was at it, I noticed
Search.scanandFacetedSearch.paramshad broken links so I fixed those as well.