Blosc/python-blosc2

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

Open

#650 建立於 2026年6月2日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (47 fork)auto 404
documentationgood first issue

倉庫指標

Star
 (207 star)
PR 合併指標
 (PR 指標待抓取)

描述

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

貢獻者指南