tektronix / tektronix/tm_data_types
[FEAT]: Add examples to docstrings and enable `pytest --doctest-modules` in tox config
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 8
- Forks
- 14
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 4
Description
Description
It would be nice if the docstrings had examples. These examples should then be tested using pytest. The tox config has a line that will perform testing, but it is currently commented out.
Additional Information
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the tox configuration and the Python modules whose docstrings lack examples. Check how pytest --doctest-modules is currently commented out, then run the doctest command to identify coverage gaps. Done means representative docstring examples are added and the tox test environment runs them successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100