Repository navigation
docs: align docs and type hints with runtime behavior - #644
Merged
Merged
Conversation
Fix mismatches called out in msiemens#630: - Query.test: Callable[..., bool] and field-value docs - operations.add: allow str in the type hint - usage.rst: fix update_multiple example; clarify get() order - package docstring: drop invented _id field - Table.get docstring: document doc_ids list / None correctly - Query.search: flags go to re.search Fixes msiemens#630
Owner
|
Thanks! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Aligns documentation and type annotations with actual runtime behavior, as listed in #630. No intentional behavior changes.
Query.testCallable[..., bool]; docstring says field valueoperations.addn: Union[int, float, str]usage.rstupdate_multiplebraces;getis first match, not random_idfieldTable.getdocstringdoc_ids→ list (possibly empty); single get → doc orNoneQuery.searchre.searchFixes #630
Test plan
uv run py.test tests/test_queries.py tests/test_operations.py tests/test_tinydb.py -q --mypy(165 passed)