Add docstring examples and tests for `mkdocstrings` and `mktestdocs`
Open
@cianc is already working on this.
Since Mar 24, 2026.
documentation
- Dominant language
- Python
- Stars
- 1.9k
- Forks
- 323
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 12
Description
Where does the documentation need improvement?
While porting the docs to zensical, I noticed some differences in the params and code. It would be nice to have a universal source of truth we can easily maintain and update, from the docstrings.
What needs to be changed?
Describe what's currently wrong or what could be better.
Additional context
Add any other context about the documentation issue here.
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.
Assessment
This issue has not been assessed yet.