Add matplotlib.testing to the documentation #12560
Conversation
doc/api/testing_api.rst
Outdated
| :show-inheritance: | ||
|
|
||
|
|
||
| :mod:`matplotlib.testing.determinism` |
There was a problem hiding this comment.
This module exposes literally no public API and is really just a helper for matplotlib.tests.test_backend_{pdf,ps,svg}. It should be renamed to something like matplotlib.tests._test_determinism_helpers.
There was a problem hiding this comment.
Ok, I've excluded it from the docs for now. It does not provide docstrings anyway. This makes it easier to rename. But that's for another PR (including a discussion if we need a deprecation first).
|
This does not doc-build because importing What should we do?
|
|
I've now not included |
|
the docs don't appear in the circleci build? |
|
No clue why CircleCI does not run on this. I've built the docs locally and they look fine. |
|
Looks reasonable then. |
PR Summary
The
testingmodule was not included in the docs. While it may not be useful for the day-to-day user, we should still publish the testing docs because it's part of the library.Not quite sure, if these do only target matplotlib developers or if other libraries can use that code too to test their matplotlib-generated plots. Improved descriptions would be nice as well, but that's for another PR.