Skip to content

Add Demonstration for Hidden Notebook Assertions #2441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

frederikschubertflex
Copy link
Contributor

@frederikschubertflex frederikschubertflex commented May 9, 2025

This PR provides a proof of concept for #1310.

The assertions are added to the notebook metadata, as exemplified for the Quickstart notebook.

This demonstrates a successful assertion and a failing one.

The notebook can for now be tested using the command

poetry run pytest --override-ini addopts="--nbmake" --override-ini testpaths="" docs/notebooks/StartHere.ipynb

The test is expected to fail at the second assertion.

@tylerflex
Copy link
Collaborator

this is great

Copy link
Collaborator

@tylerflex tylerflex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let @daquinteroflex comment on the specifics of the code changes, it's been a while since I have poked around in the docs and packaging so I'll leave it to him :)

@daquinteroflex
Copy link
Collaborator

Nice! Let's build some demo docs to see how it looks like

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants