jxnl/instructor-classify

Enable Pytest Examples to print outputs into the markdown

Offen

#1 geöffnet am 19.04.2025

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (4 Forks)auto 404
documentationenhancementgood first issue

Repository-Metriken

Stars
 (37 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Erkunde pytest Plugins, die die Ausgabe erfassen, wie pytest capture, oder schreibe einen benutzerdefinierten Hook, um stdout/stderr zu erfassen und in Markdown Dateien einzufügen. Sieh dir an, wie das README aktuell Beispiele und Ausgaben anzeigt.
Tech Stack
python
Domain
testingdocumentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Pythonpytest
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70