Skip to content

[BUG] Improve Wiki pages regarding Python 2 and venv #1743

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

Closed
septatrix opened this issue Jan 31, 2020 · 8 comments
Closed

[BUG] Improve Wiki pages regarding Python 2 and venv #1743

septatrix opened this issue Jan 31, 2020 · 8 comments
Labels
⚙️ documentation affected functionality: documentation

Comments

@septatrix
Copy link
Contributor

Expected behaviour

In accordance to #1538 (#1731 #1734 and #1715) we should default to Python 3 for wiki pages.
This would mean default to using python3 and pip3 as long as the respective versionless commands are not aliased to them in most major distributions.

Actual behaviour

The wiki does not mentions Python 3 as the default case for usage

Misc

We would need to look through all wiki pages manually.
When doing so I think would be a good time to switch to using Pythons venv in examples as I sometimes experienced a few problem installing this module globally...

@Bibo-Joshi
Copy link
Member

Hi. Sorry for the late reply.
For the python/pip3 part: Would be good yes.
For the venv: I'd suggest to rather put a note somewhere that using venv might be beneficial. But since the acutal setup of a system is up to the user, I would not rewrite the wiki to use a venv by default.
Would you maybe like to do these changes?

@Bibo-Joshi Bibo-Joshi added ⚙️ documentation affected functionality: documentation and removed bug 🐛 labels Feb 20, 2020
@Bibo-Joshi
Copy link
Member

Update: Please don't use sudo in the examples either (see #1558 ) ;)

@septatrix
Copy link
Contributor Author

Oh okay

@septatrix
Copy link
Contributor Author

Using sudo for apt though is necessary. The discussion you linked was about pip where it indeed should be avoided to use sudo and most of the time --user should be used.

@Bibo-Joshi
Copy link
Member

oh yes, overlooked that. just saw sudo and remembered #1558 :D Thanks for being busy on the wiki! Feel free to close this one you're done :)

@septatrix
Copy link
Contributor Author

septatrix commented Feb 20, 2020

Additionally i added a few ```python tags to doc strings and used python3 -m pip instead of pip as the former has a few advantages and is recommended. Maybe we should also add this issue to the 13.0 Milestone as there are a few places in the wiki where we include additional information for python 2 which we won't support in that release (otherwise feel free to close this or create a new one tracking the removal of python2 specific sections in the wiki)

@Bibo-Joshi
Copy link
Member

Mh, I feel like that can be removed when someone stumbles upon it after 13.0 is released. I'll close this for now.
thanks again for the effort :)

@Bibo-Joshi
Copy link
Member

Seems we rushed ahead a bit here. The consensus is the dev chat is that people should know what python version they use. I reverted the changes.

@github-actions github-actions bot locked and limited conversation to collaborators Aug 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
⚙️ documentation affected functionality: documentation
Projects
None yet
Development

No branches or pull requests

2 participants