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

Update the Python docs #351

Merged
merged 2 commits into from Oct 27, 2020
Merged

Update the Python docs #351

merged 2 commits into from Oct 27, 2020

Conversation

encukou
Copy link
Contributor

@encukou encukou commented Oct 20, 2020

Here's a big update to Python sections to keep them current.
The content was already reviewed by Python SIG members Zbyszek and Miro in encukou#1


Update the list of Python versions.
Remove sections for recently removed interpreters.

Change the section order to put Multiple Pythons near the top,
since this is one of the main selling points of Fedora wrt. Python.

Warn that pip installs third-party software.

Explain more clearly why virtual environments are preferred over
Fedora packages for development.

Only keep the name "virtualenv" for environments created by the actual
virtualenv tool; otherwise switch "virtual environment" or just "environment".

Update Flask docs to reflect best practice there.
Add ESP32 to the MicroPython docs.

And further rewordings and reorganization.

encukou and others added 2 commits October 13, 2020 15:15
Update the list of Python versions.
Remove sections for recently removed interpreters.

Change the section order to put Multiple Pythons near the top,
since this is one of the main selling points of Fedora wrt. Python.

Warn that pip installs third-party software.

Explain more clearly why virtual environments are preferred over
Fedora packages for development.

Only keep the name "virtualenv" for environments created by the actual
`virtualenv` tool; otherwise switch "virtual environment" or just "environment".

Update Flask docs to reflect best practice there.
Add ESP32 to the MicroPython docs.

And further rewordings and reorganization.
Co-authored-by: Miro Hrončok <miro@hroncok.cz>
Copy link
Contributor

@pvalena pvalena left a comment

Choose a reason for hiding this comment

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

Thanks for your PR, it looks great!

I've had some styling comments, but apart from that it LGTM.
Let me know if you want to keep it as it is - I'll leave it up to you.

tech/languages/python/micropython.md Show resolved Hide resolved
tech/languages/python/multiple-pythons.md Show resolved Hide resolved
tech/languages/python/multiple-pythons.md Show resolved Hide resolved
tech/languages/python/multiple-pythons.md Show resolved Hide resolved
tech/languages/python/multiple-pythons.md Show resolved Hide resolved
tech/languages/python/multiple-pythons.md Show resolved Hide resolved
tech/languages/python/python-installation.md Show resolved Hide resolved
@encukou
Copy link
Contributor Author

encukou commented Oct 21, 2020

I split the text out of habit (shorter lines make the source easier to read, at least to me). Since it doesn't affect the output, I'll keep the PR as it is.
If you have a stronger opinion, feel free to reflow the text.

@encukou
Copy link
Contributor Author

encukou commented Oct 27, 2020

Can this be merged?

@pvalena
Copy link
Contributor

pvalena commented Oct 27, 2020

Sure, LGTM.

Note that at this point, unfortunately, there's no way of generating the actual website (any help is welcome).

@pvalena
Copy link
Contributor

pvalena commented Oct 27, 2020

On the second thought- have you reviewed the result, does it actually build for you? (I'd be much happier to merge this if I could actually see it rendered correctly.)

@encukou
Copy link
Contributor Author

encukou commented Oct 27, 2020

No, I couldn't get the actual website to work locally. I rendered the markdown files using a different tool.

@pvalena
Copy link
Contributor

pvalena commented Oct 27, 2020

Ok, thanks for the message. That's good enough for me- I'll merge it then, and get back to you with if there are some visible issues.

@pvalena pvalena merged commit 95f997e into developer-portal:master Oct 27, 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

Successfully merging this pull request may close these issues.

None yet

2 participants