jxnl/instructor-classify

Enable Pytest Examples to print outputs into the markdown

オープン

#1 opened on 2025/04/19

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Python (4 件のフォーク)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (37 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド