Add runnable examples to CTable where and sort_by - #711
Open
armutlutost wants to merge 1 commit into
Open
armutlutost wants to merge 1 commit into
armutlutost wants to merge 1 commit into
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
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
Add runnable examples to the
CTable.where()andCTable.sort_by()docstrings.The examples demonstrate filtering, column projection, compound predicates, plain sorting, lazy sorting of a filtered view, and multi-key sorting.
Closes #650
Changes
CTablesetup to both docstrings.where()with a simple predicate and selected columns.Validation
python -m py_compile src/blosc2/ctable.pygit diff --checkThe repository’s required
blosc2Conda environment was unavailable locally, so the documentation examples were not executed against the compiled extension.AI disclosure
AI assistance was used to draft the documentation examples. I reviewed the changes before submitting this pull request.