Skip to content
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

Put the five executables in a list #2960

Closed
wants to merge 2 commits into from
Closed

Conversation

cclauss
Copy link

@cclauss cclauss commented Jul 28, 2017

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew tests with your changes locally?

Copy link
Contributor

@apjanke apjanke left a comment

Choose a reason for hiding this comment

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

I like this formatting change; much more readable IMHO.

One typo to fix; otherwise LGTM.

* `python` will always point to the macOS system Python
* `python2` will point to the brew-installed Python 2.7.x
* `python3` will point to the brew-installed Python 3.x
* `pip2` will point to the pip associated with the brew-installed Python 2.7x
Copy link
Contributor

Choose a reason for hiding this comment

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

"2.7.x" instead of "2.7x".

@apjanke
Copy link
Contributor

apjanke commented Jul 28, 2017

Changes look good now.

Do you mind squashing this PR to a single commit to keep our commit history tidy?

@@ -9,7 +9,12 @@ Homebrew provides formulae to brew a more up-to-date Python 2.7.x and 3.x.
**Important:** If you choose to install a Python which isn't either of these two (system Python or brewed Python), the Homebrew team can only provide limited support.

## Python 2.x or Python 3.x
Homebrew provides a formula for Python 2.7.x and one for Python 3.x. They don't conflict, so they can both be installed. The executable `python2` will always point to the 2.x and `python3` to the 3.x version. The executable `python` will always point to the macOS system Python.
Homebrew provides one formula for Python 2.7.x and another for Python 3.x. The executables are organized as follows so that Python 2 and Python 3 can both be installed without conflict:
* `python` will always point to the macOS system Python
Copy link
Contributor

Choose a reason for hiding this comment

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

I appreciate the wording exists already but "always" seems misleading here given:

This formula installs a python2 executable to /usr/local/bin.
If you wish to have this formula's python executable in your PATH then add
the following to ~/.zshrc:
  export PATH="/usr/local/opt/python/libexec/bin:$PATH"

Perhaps, "by default" instead.

@ilovezfs
Copy link
Contributor

I think the existing wording is more succinct and equally clear, so I'd prefer we not make this change, as it only makes the text more repetitive.

@cclauss
Copy link
Author

cclauss commented Jul 29, 2017

Closing in favor of #2963

@cclauss cclauss closed this Jul 29, 2017
@cclauss cclauss deleted the patch-1 branch July 29, 2017 08:18
@Homebrew Homebrew locked and limited conversation to collaborators May 4, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants