[doc]: added section Verify installation #26565
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
story645
reviewed
Aug 21, 2023
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. |
There was a problem hiding this comment.
Suggested change
| 1. Run the following command to make sure you have correctly installed matplotlib in editable mode. | |
| Run the following command to make sure you have correctly installed Matplotlib in editable mode. |
our style guide has Matplotlib always capitalized
doc/devel/development_setup.rst
Outdated
|
|
||
| This command should return : ``<matplotlib_local_repo>\lib\matplotlib\__init__.py`` | ||
|
|
||
| 2. We encourage you to run tests and build docs to verify that the code installed correctly and that the docs build are clean, |
There was a problem hiding this comment.
Suggested change
| 2. We encourage you to run tests and build docs to verify that the code installed correctly and that the docs build are clean, | |
| We encourage you to run tests and build docs to verify that the code installed correctly and that the docs build cleanly, |
There was a problem hiding this comment.
Ok the suggested changes are done, can you help to re-review it, thanks.
|
Does this supersede #26416? |
5 tasks
devilsaint99
force-pushed
the
doc-install-verify
branch
from
91ca64c
to
6f6241a
Compare
|
I'm not sure where the white space is - I suggest rerunning the hook locally and then staging and commiting the file after the hook runs. |
ksunden
reviewed
Aug 23, 2023
doc/devel/development_setup.rst
Outdated
Comment on lines
170
to
174
| Run the following command to make sure you have correctly installed Matplotlib in editable mode. | ||
| The command should be run when the virtual environment is activated :: | ||
|
|
||
| python -c "import matplotlib; print(matplotlib.__file__)" | ||
|
|
There was a problem hiding this comment.
Suggested change
| Run the following command to make sure you have correctly installed Matplotlib in editable mode. | |
| The command should be run when the virtual environment is activated :: | |
| python -c "import matplotlib; print(matplotlib.__file__)" | |
| Run the following command to make sure you have correctly installed Matplotlib in editable mode. | |
| The command should be run when the virtual environment is activated :: | |
| python -c "import matplotlib; print(matplotlib.__file__)" | |
Hint: selecting text on github makes it easy to find where the trailing whitespace is
|
Um @devilsaint99 let us know if you'd like to do the rebase or have us do it? |
[doc]: added section Verify Installation [doc]: added section Verify installation
devilsaint99
force-pushed
the
doc-install-verify
branch
from
6f6241a
to
d03fce0
Compare
story645
approved these changes
Aug 25, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Aug 25, 2023
|
Congrats on your first PR to Matplotlib, thank you for all the effort you've put into this, and we hope to see you again🥳 |
ksunden
added a commit
that referenced
this pull request
Aug 25, 2023
…565-on-v3.8.x Backport PR #26565 on branch v3.8.x ([doc]: added section Verify installation)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
PR checklist