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.

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

Enable doctests in pydoctor docstrings #844

Open
tristanlatr opened this issue Dec 5, 2024 · 0 comments
Open

Enable doctests in pydoctor docstrings #844

tristanlatr opened this issue Dec 5, 2024 · 0 comments

Comments

@tristanlatr
Copy link
Contributor

We currently use doctests in the testing but only through .doctest files under pydoctor/test/epydoc/.
Some objects like ParsedTypeDocstring, TypeDocstring, modify_iter, _configparser.py have doctests that demonstrate the usage or implementation details. So enabling this feature should help maintaining this documentation in the time.

We also have case like the in the astutils.iterassign where the docstest is not used to demontrate code usage but simply to colorize the python code. These can be replaced by epytext literal block syntax ::.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant