jxnl / jxnl/instructor-classify

Enable Pytest Examples to print outputs into the markdown

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement good first issue
Dominant language
Python
Stars
37
Forks
4
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.