Blosc/python-blosc2

Add runnable code snippets to CTable.where() and sort_by() docstrings

Open

#650 opened on 2026年6月2日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (47 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (207 stars)
PR merge metrics
 (PR metrics pending)

説明

The docstrings for CTable.where() and CTable.sort_by() describe the API well but contain no runnable Examples: section. New contributors exploring the API in a REPL or reading rendered API docs get no concrete illustration of the lazy-view behaviour introduced in this release.

Suggested work: Add an Examples section to both docstrings (NumPy docstring format) showing:

  • where(): filter with a simple predicate, with columns=, and with a compound condition
  • sort_by(): sort a plain table, sort a filtered view (demonstrating that it stays lazy until iterated), and multi-key sort
  • Both should include print() calls that make the lazy-vs-eager distinction visible

コントリビューターガイド