You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Have instructions for checking that the version that's installed matches the last commit import matplotib; matplotib.__version__ is the repo import matplotlib; matplotlib.__file__
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.
The text was updated successfully, but these errors were encountered:
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)
Should 2 and 3 come with a warning that they are quite expensive to run?
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"
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.
The text was updated successfully, but these errors were encountered: