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 automated testing of example code in docstrings #46

Open
troyraen opened this issue Jul 1, 2024 · 0 comments
Open

Add automated testing of example code in docstrings #46

troyraen opened this issue Jul 1, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@troyraen
Copy link
Contributor

troyraen commented Jul 1, 2024 •
edited
Loading

Many of our class docstrings now contain example code demonstrating usage (e.g., Subscription). It would be great to implement some automated testing of this code. Bonus points for integrating with the test suite that was implemented in #7. Potential solutions are:
@troyraen troyraen added enhancement New feature or request good first issue Good for newcomers labels Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@troyraen