Skip to content

Possibly a missing parameter in the documentation of DocTestSuite in doctest #99970

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

Closed
busywhitespace opened this issue Dec 3, 2022 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@busywhitespace
Copy link
Contributor

busywhitespace commented Dec 3, 2022

The documentation for DocTestSuite in doctest have the following signature.

DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, checker=None)

But the documentation also talks about optionflags.

Optional arguments setUp, tearDown, and optionflags are the same as for function DocFileSuite() above.

In my opinion, when setUp and trearDown are mentioned in the signature, optionflags should be in the signature too.

I've created PR in case the issue is correct.

Linked PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

2 participants