Blosc/python-blosc2

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

Open

#650 aperta il 2 giu 2026

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (47 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (207 star)
Metriche merge PR
 (Metriche PR in attesa)

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 contributor

Direzione di ricerca
Leggi i docstring esistenti di CTable.where() e CTable.sort by(), quindi aggiungi sezioni Esempi seguendo il formato NumPy. Assicurati che gli esempi mostrino il comportamento lazy vs eager.
Tech stack
python
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85