8000 DOC: Update INSTALL.rst by AnkurDedania · Pull Request #12187 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: Update INSTALL.rst #12187

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 20, 2018
Merged

DOC: Update INSTALL.rst #12187

merged 1 commit into from
Sep 20, 2018

Conversation

AnkurDedania
Copy link
Contributor

PR Summary

fix command typo in INSTALL.rst

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@AnkurDedania
Update INSTALL.rst
113125f 
fix command typo
@ImportanceOfBeingErnest
Copy link
Member

Are there cases where python -mpip ... gives a different result than python -m pip ...?

@QuLogic
Copy link
Member
QuLogic commented Sep 20, 2018

I don't think so. While it's true that single-letter options can be combined after a single dash (e.g., -sv), -m is documented as terminating the option list, and it does, since -mpip neither errors due to unknown option (-p is not an option), nor causes interactive inspection (-i).

@tacaswell tacaswell added this to the v3.0.0-doc milestone Sep 20, 2018
@tacaswell
Copy link
Member

I am 50/50 on this. I normally do pytthon -mpip because I am lazy, but also see the case that adding the space is clearer.

@anntzer
Copy link
Contributor
anntzer commented Sep 20, 2018

I'd rather leave it as -mpip, let's say -0.

timhoffm
timhoffm approved these changes Sep 20, 2018
View reviewed changes
Copy link
Member
@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

+0.5 on this. While -mpip is a handy shortcut, the spaced version is more clear and thus easier to understand. pip itself documents it with space. I think we should follow their example.

ImportanceOfBeingErnest
ImportanceOfBeingErnest approved these changes Sep 20, 2018
View reviewed changes
Copy link
Member
@ImportanceOfBeingErnest ImportanceOfBeingErnest left a comment

Choose a reason for hiding this comment

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

I totally buy the argument that pip itself documents the usage as python -m pip .... While people who know that they can shorten this, won't actually care about seeing it differently, new users might get confused by the concatenated form.

@tacaswell tacaswell merged commit f1a4d98 into matplotlib:master Sep 20, 2018
@tacaswell
Copy link
Member

@meeseeksdev backport to v3.0.0-doc

@lumberbot-app
Copy link
lumberbot-app bot commented Sep 20, 2018

Something went wrong ... Please have a look at my logs.

@Carreau
Copy link
Contributor
Carreau commented Sep 21, 2018

@meeseeksdev backport to v3.0.0-doc

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 21, 2018
@tacaswell
Backport PR matplotlib#12187: DOC: Update INSTALL.rst
30119cc
@meeseeksmachine meeseeksmachine mentioned this pull request Sep 21, 2018
Merged
timhoffm pushed a commit that referenced this pull request Sep 21, 2018
@meeseeksmachine @timhoffm
Backport PR #12187: DOC: Update INSTALL.rst (#12195)
0873dcb
@AnkurDedania
Copy link
Contributor Author

Looking at the code, I found other files referencing python -mpip ...

@tacaswell
Copy link
Member

@AnkurDedania can you open another PR to fix those too?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

@ImportanceOfBeingErnest ImportanceOfBeingErnest ImportanceOfBeingErnest approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.0.0-doc
Development

Successfully merging this pull request may close these issues.
7 participants
@AnkurDedania @ImportanceOfBeingErnest @QuLogic @tacaswell @anntzer @Carreau @timhoffm
0