jxnl/instructor-classify

Enable Pytest Examples to print outputs into the markdown

Open

#1 opened on Apr 19, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (4 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (37 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Explore pytest plugins that capture output like pytest capture or write a custom hook to capture stdout/stderr and insert into markdown files. Look at how the README currently displays examples and outputs.
Tech stack
python
Domain
testingdocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonpytest
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70