Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Run code snippets in CI #1451

Open
Run code snippets in CI#1451
Feature
Labels
documentationImprovements or additions to documentationgithub_actionsPull requests that update GitHub Actions codegood first issueGood for newcomers

Description

Description
The user guide was mostly written years ago and the code snippets aren't regularly run, I don't think.

This leads to unfortunate outcomes such as the documented behavior being explicitly wrong (#1433, possibly #1450)

It would be nice to have a runner go through code snippets in these Markdown files periodically, akin to how Jupyter notebooks are run in regular CI. I think the toolkit does something like this

Docstrings, too?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgithub_actionsPull requests that update GitHub Actions codegood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions