Add runnable code snippets to CTable.where() and sort_by() docstrings
- 主要言語
- Python
- スター
- 211
- フォーク
- 58
- 平均マージ
- 1日 17時間
- マージ済み PR(30日)
- 6
説明
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
コントリビューションガイド
調査の方向性
CTable.where() と CTable.sort_by() の docstring から始め、編集する前にリポジトリに既にある NumPy 形式の例を確認してください。要求された述語、列の選択、フィルタリング、単一キーおよび複数キーによるソート、lazy views の実行可能な例を、評価がいつ行われるかが分かる print() 出力とともに追加してください。両方の docstring が有効な例としてレンダリングされれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 半日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 74/100