jxnl/instructor-classify

Enable Pytest Examples to print outputs into the markdown

Ouverte

#1 ouverte le 19 avr. 2025

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (4 forks)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (37 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

As mentioned in the README, we need to enable Pytest examples to print outputs into the markdown documentation.

Description

When running tests, add a mechanism to capture the outputs and incorporate them into the markdown documentation automatically.

Tasks

  • Find a suitable approach to capture pytest outputs
  • Add mechanism to insert these outputs into markdown files
  • Ensure the output formatting is consistent with markdown syntax
  • Update documentation to explain how this feature works

Why is this important?

This will help keep code examples and their outputs in sync, improving documentation accuracy.

Difficulty

Good first issue - suitable for new contributors

Guide contributeur

Direction de recherche
Explorez les plugins pytest qui capturent la sortie comme pytest capture ou écrivez un hook personnalisé pour capturer stdout/stderr et les insérer dans les fichiers markdown. Regardez comment le README affiche actuellement les exemples et les sorties.
Stack technique
python
Domaine
testingdocumentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Pythonpytest
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70