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.

Sign up for GitHub

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

Jump to bottom

Add doctest tests #18

Open
RastislavTuranyi opened this issue Jan 28, 2025 · 0 comments
Open

Add doctest tests #18

RastislavTuranyi opened this issue Jan 28, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation nice to have Something that would be nice to have but is not critical testing Improvements or problems in test suite

Comments

@RastislavTuranyi
Copy link
Collaborator

RastislavTuranyi commented Jan 28, 2025 •
edited
Loading

As the documentation expands (e.g. #15) and more examples are added, it will become indispensable to introduce a tool that can help us make sure that they stay up-to-date. The standard for this is doctest

A potential problem with this is that some of the examples in some of the how-to guides (especially the ones that work with custom yaml files) may not actually pass the doctests.
@RastislavTuranyi RastislavTuranyi added documentation Improvements or additions to documentation nice to have Something that would be nice to have but is not critical testing Improvements or problems in test suite labels Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation nice to have Something that would be nice to have but is not critical testing Improvements or problems in test suite
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@RastislavTuranyi