Add documentation tests#9
Merged
SmartMonkey-git merged 5 commits intoSmartMonkey-git:mainfrom Aug 2, 2025
Merged
Conversation
SmartMonkey-git
approved these changes
Aug 2, 2025
Owner
SmartMonkey-git
left a comment
SmartMonkey-git
left a comment
There was a problem hiding this comment.
Some minor changes.
Otherwise, awsome! Thank you for your contribution. 👍 ❤️
| >>> foo() | ||
| True | ||
|
|
||
| ``` |
Owner
There was a problem hiding this comment.
The way you phrased it, it sounds like the code snipped is imporant. However, I think what you actually wanted to make is an example on how to write a doctest, right?
So, maybe:
Suggested change
| ``` | |
| the most imporant functionality. For example snippets like these will be executed by pytest: | |
| ```python | |
| >>> from project_name.foo import foo | |
| >>> foo() | |
| True | |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
Collaborator
Author
|
@SmartMonkey-git thanks for the review and the suggestions. I applied them (plus a minor rewrite) and I removed the pydoc example (it's probably too niche for the template). Please let me know if the revised version looks OK and feel free to merge if yes. Thank you! |
SmartMonkey-git
approved these changes
Aug 2, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The PR sets up the documentation tests, adds a README section about tests, and an example doctest.
@SmartMonkey-git I also changed the heading level of Continuous Delivery to ##, it seemed more appropriate.