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

docs: Clarify "python" vs "python3" #14

Closed
pfalcon opened this issue Sep 2, 2019 · 6 comments
Closed

docs: Clarify "python" vs "python3" #14

pfalcon opened this issue Sep 2, 2019 · 6 comments

Comments

@pfalcon
Copy link
Contributor

pfalcon commented Sep 2, 2019

It looks like PPCI requires Python3, which is great. It looks like "python -m ppci" syntax is used somewhere in the docs (as suggested in #11), which is also great: https://ppci.readthedocs.io/en/latest/reference/lang/java.html#compile-java-ahead-of-time

However, that uses exactly python, and for most users nowadays that will lead to stack trace ending with:

AssertionError: Needs to be run in python version 3.x

Not exactly user friendly (especially for people not familiar with Python, and #11 suggests to keep those in mind).

So, suggested to use python3 consistently in the commands everywhere.

@pfalcon pfalcon mentioned this issue Sep 2, 2019
6 tasks
@pfalcon
Copy link
Contributor Author

pfalcon commented Jan 1, 2020

@windelbouwman: Do you agree that this makes sense, should I make such a change if see a bare "python" command usage?

@windelbouwman
Copy link
Owner

Hmm, I don't know, since python2 is officially dead (for some hours ;)), we might assume the default is python3 now? I propose to leave the docs as it is, and improve the error message, which I agree is poor, and should be more explaining.

@windelbouwman
Copy link
Owner

I added a more explanatory error message 726dea0 do you mean something like this?

@pfalcon
Copy link
Contributor Author

pfalcon commented Jan 1, 2020

Hmm, I don't know, since python2 is officially dead (for some hours ;)), we might assume the default is python3 now?

I personally don't think we can. While "official" deadline has been passed, my system still has "python" pointing to "python2". And it's the same for millions of other users, for months to come, and for sizable numbers still, for years to come. And I expect the echo of confusion to roll around for the next 10-20 years. While "python3" is already there, will be there, and even was there all the time.

I propose to leave the docs as it is, and improve the error message, which I agree is poor, and should be more explaining.

Ok, but then I'd suggest to keep this ticket open, and revisit again in some time.

@pfalcon
Copy link
Contributor Author

pfalcon commented Jan 1, 2020

I added a more explanatory error message 726dea0 do you mean something like this?

Yes, that's detailed enough, thanks.

@pfalcon
Copy link
Contributor Author

pfalcon commented Jan 18, 2020

Ok, in the name of keeping set of open tickets (more) manageable, let's close this ticket (in preference of more "meta" tickets). I for one got that preference is to use bare "python", and followed in e.g. https://github.com/windelbouwman/ppci-mirror/pull/39/files#diff-112623563404e927d73b171234939b31R1 to be consistent within the project, even though I myself would use "pyhon3".

We can reopen if there will be actual user reports of confusion.

@pfalcon pfalcon closed this as completed Jan 18, 2020
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

No branches or pull requests

2 participants