Skip to content

Improve setuptools.txt #1966

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 3 commits into from
Jan 16, 2020
Merged

Improve setuptools.txt #1966

merged 3 commits into from
Jan 16, 2020

Conversation

geryogam
Copy link
Contributor

@geryogam geryogam commented Jan 13, 2020

This PR will make the following changes:

  • fix some typos;
  • remove the python command from setup.py calls;
  • uniformise quotation marks.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@geryogam
Copy link
Contributor Author

Would you like to review this PR @jaraco?

@jaraco
Copy link
Member

jaraco commented Jan 14, 2020

Hey @maggyero. How about instead of adding python setup.py everywhere, write one section that explains (or links to an explanation on) how to execute a Python script and to avoid proliferating the otherwise obvious execution semantics? In other words, I'd like to use the minimum text/code that achieves the desired purpose.

The use of python setup.py only works in some scenarios, such as when python points to the preferred interpreter (which it often doesn't, especially in today's split Python 2/3 world). In practice, the user will need to execute python3 setup.py or py -3 setup.py or some other invocation.

Moreover, *.py works on Windows (invoking the default Python interpreter) and ./setup.py works on Unix OSs, assuming the 'executable' bit is set. All of these nuances are difficult to capture in each and every execution, which is why the documentation leaves it as an exercise to the user to figure out the best way to execute the python script, and why simply setup.py is preferable to python setup.py.

How about simply removing the python3 from the `setup.py invocation, and fix the other typos?

@geryogam
Copy link
Contributor Author

@jaraco

How about simply removing the python3 from the `setup.py invocation, and fix the other typos?

That makes sense. Updated.

@jaraco jaraco merged commit 682b651 into pypa:master Jan 16, 2020
@geryogam geryogam deleted the patch-1 branch January 16, 2020 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants