Blosc / Blosc/python-blosc2

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

Ouverte Adaptée aux débutants
#650 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation good first issue
Langage dominant
Python
Étoiles
211
Forks
58
Merge moyen
1 j 17 h
PR mergées (30 j)
6

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par les docstrings de CTable.where() et CTable.sort_by() et examinez les exemples existants au format NumPy du dépôt avant de modifier quoi que ce soit. Ajoutez des exemples exécutables pour les prédicats demandés, la sélection de colonnes, le filtrage, le tri simple et le tri multi-clés, ainsi que pour les vues lazy, avec une sortie de print() qui montre quand l’évaluation a lieu ; c’est terminé lorsque les deux docstrings rendent des exemples valides.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
Une demi-journée
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
74/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.