mwvgroup/pittgoogle-client

Add automated testing of example code in docstrings

Open

#46 opened on Jul 1, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (1 fork)auto 404
enhancementgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

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:

Contributor guide

Research direction
Implement automated testing of example code in docstrings using sphinx.ext.doctest or pytest doctestplus. Integrate with the existing test suite from #7 by adding a configuration file or modifying the test runner.
Tech stack
python
Domain
backendtesting qa
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70