[doc]: add 'validate' section to install docs #26379 #26416
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
doc/devel/development_setup.rst
Outdated
| 2. Link to the running the tests page to verify that the code installed clean: | ||
| :ref:`testing` | ||
| 3. Link to the building the docs page to verify that the docs build clean: | ||
| :ref:`documenting-matplotlib` |
There was a problem hiding this comment.
While these were the instructions for writing this page, folks validating their install do not need to link to these pages. Please rewrite this to be instructive to the audience reading it.
doc/devel/development_setup.rst
Outdated
| Verify the Installation | ||
| ============================== | ||
|
|
||
| 1. Run the following command to make sure you have correctly installed matplotlib in editable mode. The command should be run when virtual environment is activate. |
There was a problem hiding this comment.
| 1. Run the following command to make sure you have correctly installed matplotlib in editable mode. The command should be run when virtual environment is activate. | |
| 1. Run the following command to make sure you have correctly installed matplotlib in editable mode. The command should be run in the development virtual environment when the environment is active. |
There was a problem hiding this comment.
This needs to be changed because a) the development is incomplete - development what? b) subjects activate, objects are activated- since the environment can't activate itself, it is activated
doc/devel/development_setup.rst
Outdated
| * We would encourage you to run tests and build docs to verify that the code installed and docs build are clean respectively, | ||
| These two are recommended, so that when you make code or document related changes you are aware of the existing issues beforehand. |
There was a problem hiding this comment.
Way better! Small suggestion to tighten the wording:
| * We would encourage you to run tests and build docs to verify that the code installed and docs build are clean respectively, | |
| These two are recommended, so that when you make code or document related changes you are aware of the existing issues beforehand. | |
| * We encourage you to run tests and build docs to verify that the code install and docs build are clean, , so that when you make code or document related changes you are aware of the existing issues. |
And then I suggest a small bulleted list kinda like:
`
- verify install : :ref:
testing - verify documentation build: :ref:
documenting-matplotlib
`
so that someone who is skimming can quickly find the link.
|
Hi @story645, I have made the requested changes and it's ready for review one more time. |
|
do the docs build locally? |
doc/devel/development_setup.rst
Outdated
| ============================== | ||
|
|
||
| * Run the following command to make sure you have correctly installed matplotlib in editable mode. | ||
| The command should be run in the development when the virtual environment is activate :: |
There was a problem hiding this comment.
| The command should be run in the development when the virtual environment is activate :: | |
| The command should be run when the virtual environment is activated :: |
|
Hi, this needs to be rebased. Would you like to do it (w/ help if needed) or would you like me to? It doesn't impact this getting merged, it's just about conforming to our code style. |
Hi Hannah, I will need help since I have never done rebase |
|
Sure, https://matplotlib.org/devdocs/devel/contribute.html#contributor-incubator is the channel for this sorta help. Also which code editor are you using? |
|
5de29bf to
969109f
Compare
|
Sorry I missed your reply. VSCode's gitlens extension has a really nice interactive rebase tool. you type more general info about rebases at https://matplotlib.org/devdocs/devel/development_workflow.html#rebase-onto-upstream-main Also your repo ended up getting really tangled so I cleaned it by dropping most of the commits and then copy and pasting changes in w/ some formatting tweaks and rebasing that commit. I'm gonna leave this open for a bit so you can make changes if you'd like. |
doc/devel/development_setup.rst
Outdated
| Verify the Installation | ||
| ============================== |
There was a problem hiding this comment.
| Verify the Installation | |
| ============================== | |
| Verify the Installation | |
| ======================= |
doc/devel/development_setup.rst
Outdated
| ============================== | ||
|
|
||
| Run the following command to make sure you have correctly installed matplotlib | ||
| in editable mode. The command should be run in the development when the virtual |
There was a problem hiding this comment.
I don't understand what "in the development" means here.
There was a problem hiding this comment.
Hi, I think we can remove "the development", just virtual env makes more sense to me now.
|
@devilsaint99 to make the changes @QuLogic recommended-which need to be made before a merge b/c they're formatting and grammar - you can either accept the commit and let us squash merge or pull the changes here, make the suggested changes, and then push back up. Also this is a good rebase tutorial https://m.youtube.com/watch?v=3o_01F04bZ4 |
Hi @story645, I tried to rebase, it's stuck on merge conflict, tried to resolve conflicts but it's not working. Can I open a new with a new branch instead? |
Sure! |
|
Replace by #26565. |
PR summary
Added new section to validate the installation of matplotlib in editable mode as suggested in the isuue #26379.
PR checklist