[DOC]: Fix docstring defaults for query filters #4282
Merged
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.
Description of changes
The docstrings for
where
andwhere_document
indicated that they default to{}
. This is inconsistent with the actual type definition, and additionally confusing because sendingNone
is OK, but sending{}
is not.So, this is a small find-and-replace for these instances.
NOTE
This also comes up with respect to the
headers
in the Docs site regarding the HTTP Client. In this case, the docs are clearly inconsistent with the code right above it, but I wasn't sure if I should change it, becauseNone
gets converted to{}
in sending the request. I'm still inclined to correct it to match the actual code.Test plan
How are these changes tested?
pytest
for python,yarn test
for js,cargo test
for rustDocumentation Changes
Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?