Skip to content

Fixed installation guide command typo #23009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2022

Conversation

andrew-fennell
Copy link
Contributor

PR Summary

I'm think python -mpip ... is supposed to be python -m pip ... in both of the cases in the installation guide.

PR Checklist

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@andrew-fennell
Copy link
Contributor Author

I also noticed that the installation document uses python for everything, but the entire "Checking your installation" section uses python3.

Is this intentional? If not, I can standardize that as apart of this PR.

https://matplotlib.org/stable/users/installing/index.html?highlight=visual%20studio#checking-your-installation

@@ -281,11 +281,11 @@ be manually installed on Macports with ::
Once pip is installed, you can install Matplotlib and all its dependencies with
from the Terminal.app command line::

python3 -mpip install matplotlib
python3 -m pip install matplotlib

(``sudo python3.6 ...`` on Macports).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some Mac person (@greglucas I have identified as one) can probably tell if there is a better thing than 3.6 to write here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I now realize that the whole section is about OSX, so probably I should stop reviewing...

But my, not very qualified, guess is that you are doing the right thing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After reading up a bit:

  • Both -mpip and -m pip works, but consistency is nice.
  • OSX comes with 2.7 as default python so for the OSX parts it should be python3.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't realize -mpip was valid.

In that case, maintainers can decide whether consistency warrants a change. I'm OK with it either way.

@oscargus Thank you for looking into both of those issues!

Copy link
Member

@timhoffm timhoffm May 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's always use -m pip. While I personally leave out the space when typing, separating the parameter and it's argument is more clear.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is most definitely a better thing than 3.6 to use because we don't support 3.6 anymore 😄 We should probably change all of the python3.x to python3 everywhere... Unfortunately, mac is still only shipping with python2 by default (on my recently upgraded system at least), so python is not good enough here.

@timhoffm
Copy link
Member

timhoffm commented May 8, 2022

For simplicity, I merge this as is. If there is interest in sorting out the python3 topic, that can be addressed separately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants