jxnl/instructor-classify

Enable Pytest Examples to print outputs into the markdown

Aperta

#1 aperta il 19 apr 2025

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Python (4 fork)auto 404
documentationenhancementgood first issue

Metriche repository

Star
 (37 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esplora i plugin pytest che catturano l'output come pytest capture o scrivi un hook personalizzato per catturare stdout/stderr e inserirli nei file markdown. Guarda come il README attualmente mostra esempi e output.
Tech stack
python
Dominio
testingdocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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
Pythonpytest
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70