Skip to content
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

Add testcase that runs code blocks in readme #77

Merged
merged 7 commits into from
Jun 27, 2024
Merged

Add testcase that runs code blocks in readme #77

merged 7 commits into from
Jun 27, 2024

Conversation

thequilo
Copy link
Member

Extracts and runs code blocks in README.md.

Tests the output of print statements against the following comment lines, ignoring any whitespace.

Only executes python cells and parses STM cells. All other cells are not tested.

@thequilo
Copy link
Member Author

We could also test bash/shell cells, but then we have to introduce a mechanism to exclude cells, e.g. git clone (don't we?)

@boeddeker
Copy link
Member

We could also test bash/shell cells, but then we have to introduce a mechanism to exclude cells, e.g. git clone (don't we?)

I think we have to shell cells, that could be executed. Hence, it should be fine to exclude all. (The shell executable are just with single backticks)

Copy link
Member

@boeddeker boeddeker left a comment

Choose a reason for hiding this comment

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

Fine with the offline requested changes

@thequilo thequilo merged commit 6e42e01 into main Jun 27, 2024
6 checks passed
@thequilo thequilo deleted the test_readme branch June 27, 2024 10:38
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.

2 participants