Skip to content

feature: docs as tests - validate computed output against the output in the codeblock #72

Description

@benjamincburns

Problem

I want to know if I've introduced a bug in my project that broke my documentation.

Describe the solution you'd like

There could be two parts to this.

  • make pycon work more like docstring tests, and error if the computed output doesn't match the output shown in the markdown
  • add an option that makes other codeblocks work more like traditional replay tests by capturing the output to files somewhere, and then on recompute, checking the recomputed outputs against those files

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

featureNew feature or requestinsidersCandidate for Insiders

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions