Description
Documentation Link
https://matplotlib.org/devdocs/devel/development_setup.html
Problem
The install docs don't have instructions on how to check that the install went through correctly. I think, especially for new contributors, it'd be helpful if we offered a drop more guidance.
Suggested improvement
Add a new section to https://github.com/matplotlib/matplotlib/blob/main/doc/devel/development_setup.rst after install in editable mode. This section should:
-
Have instructions for checking that the version that's installed
matches the last commitis the repoimport matplotib; matplotib.__version__
import matplotlib; matplotlib.__file__
-
Link to the running the tests page to verify that the code installed clean: https://github.com/matplotlib/matplotlib/blob/main/doc/devel/testing.rst#L35
-
Link to the building the docs page to verify that the docs build clean: https://github.com/matplotlib/matplotlib/blob/main/doc/devel/document.rst
Tests and docs should be sentences with links (or a bullet list of table) and not the instructions specifically so that this section acts as an introduction/nudge to those pages and so that we won't have to maintain two sets of instructions.