Repository navigation
[doc]: add 'validate' section to install docs #26379
Description
Documentation Link
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.
Activity
timhoffm commentedon Jul 24, 2023
I'd rather check that
matplotlib.__file__is the checked out git repo.rcomer commentedon Jul 26, 2023
Should 2 and 3 come with a warning that they are quite expensive to run? Also, how much should a contributor worry if some tests fail? Because some do for me, and I have reason to believe I’m not alone #17096 (comment)
story645 commentedon Jul 26, 2023
Definitely, but I think we should encourage em anyways, mostly so that they have a baseline for what is failing before they start making changes. I also think it may be worth adding a note of some sort that says "parts of this build may fail for x/y/z/ reasons. Please reach out on [comms channels] if you're unsure if the failure is due to the changes you've made in your contribution"