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 in hidden doctests for our format API. #208

Merged
merged 3 commits into from
Jan 11, 2025
Merged

Add in hidden doctests for our format API. #208

merged 3 commits into from
Jan 11, 2025

Conversation

Alexhuszagh
Copy link
Owner

This enables us to ensure our format API is tested directly next to our expected behavior, using our custom docs.py script to build custom doctests that are hidden from our documentation.

This uses a <-- TEST ... --> HTML marker tags for adding in our custom tests.

2025-01-11 09_30_37

@Alexhuszagh Alexhuszagh added the documentation Fix in the documentation label Jan 11, 2025
@Alexhuszagh Alexhuszagh self-assigned this Jan 11, 2025
@Alexhuszagh Alexhuszagh marked this pull request as draft January 11, 2025 16:07
@Alexhuszagh Alexhuszagh marked this pull request as ready for review January 11, 2025 19:09
@Alexhuszagh
Copy link
Owner Author

The failing unittests are expected and will be patched shortly.

@Alexhuszagh Alexhuszagh merged commit ae4e89c into main Jan 11, 2025
38 of 39 checks passed
@Alexhuszagh Alexhuszagh deleted the fmt-tests branch January 11, 2025 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Fix in the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant