Skip to content

Conversation

@furkanonder
Copy link
Contributor

@furkanonderfurkanonder commented Jan 12, 2023

@bedevere-botbedevere-bot added docs Documentation in the Doc dir skip news labels Jan 12, 2023
@furkanonderfurkanonder changed the title gh-100972: Prefer "python" over "python3"gh-100972: For command line examples in the documentation, use "python" rather than "python3Jan 12, 2023
Copy link
Member

@hugovkhugovk left a comment

Choose a reason for hiding this comment

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

Thanks!


* Python now gets the absolute path of the script filename specified on
the command line (ex: ``python3 script.py``): the ``__file__`` attribute of
the command line (ex: ``python script.py``): the ``__file__`` attribute of
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see much value in changing old release notes.

@vsajip
Copy link
Member

Doesn't this assume that the system Python installation will be Python 3.x such that "python" will start a 3.x interpreter? If that's the case, it shouldn't be needed to specify "python3" for "-m venv" usages, right? Also, is it definitely the case that "python" will invoke 3.x on all platforms, old and new? For example I have some (not very) old Ubuntu machines where "python3" is needed. Anyone following along the documentation with this change could run into problems.

@rhettinger
Copy link
Contributor

On my Mac, python no longer refers to an executable. Only python3 works. So, at least for Mac Users, the status quo is better. With the proposed substitutions, the examples won't work any more.

@furkanonder
Copy link
ContributorAuthor

On my Mac, python no longer refers to an executable. Only python3 works. So, at least for Mac Users, the status quo is better. With the proposed substitutions, the examples won't work any more.

If there are problems with the Mac, I think this PR should be reverted.

@hugovkhugovk changed the title gh-100972: For command line examples in the documentation, use "python" rather than "python3gh-100972: For command line examples in the documentation, use "python" rather than "python3"Apr 7, 2023
@erlend-aasland
Copy link
Contributor

On my Mac, python no longer refers to an executable. Only python3 works. So, at least for Mac Users, the status quo is better. With the proposed substitutions, the examples won't work any more.

If there are problems with the Mac, I think this PR should be reverted.

I disagree; reverting that PR will only create more churn (both in the git history, but more importantly also by burning CI and contributor time). I'm closing this and the linked issue:

  • There is no uncontroversial way to fix this
  • Many core devs will categorise spelling fixes (including this) as churn; even more so given there is no consensus

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

Labels

awaiting mergedocsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants

@furkanonder@vsajip@rhettinger@erlend-aasland@hugovk@felixxm@MonadChains@bedevere-bot@AlexWaygood