Add runnable code snippets to CTable.where() and sort_by() docstrings
- Lingua principale
- Python
- Stelle
- 211
- Fork
- 58
- Merge medio
- 1g 17h
- PR unite (30g)
- 6
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Start at the CTable.where() and CTable.sort_by() docstrings and review the repository's existing NumPy-format examples before editing. Add runnable examples for the requested predicates, column selection, filtering, plain and multi-key sorting, and lazy views, with print() output that exposes when evaluation occurs; done means both docstrings render valid examples.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- Mezza giornata
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 74/100