Blosc/python-blosc2

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

Open

#650 aberto em 2 de jun. de 2026

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (47 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (207 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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

Guia do colaborador

Direção de pesquisa
Leia os docstrings existentes de CTable.where() e CTable.sort by() e adicione seções de Exemplos seguindo o formato NumPy. Certifique se de que os exemplos demonstrem o comportamento lazy vs eager.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85