Improve the Distributing Python Modules and Installing Python Modules documentation #16822
Conversation
geryogam
changed the title
| ############################### | ||
| **************************** | ||
| Distributing Python Packages | ||
| **************************** |
There was a problem hiding this comment.
Hello! Thanks for making a PR to improve Python docs!
Distutils is deprecated: its code and docs have been adopted by the setuptools project. Distutils and setuptools are also less important now that pyproject.toml exists so that people can use different build tools and keep compatibility with PyPI and pip / tox / etc.
For these reasons, I would only accept clear fixes, not formatting or style changes. The two changes here for example (header style and word choice) are out of scope.
| @@ -31,10 +30,10 @@ installing other Python projects, refer to the | |||
| Key terms | |||
| ========= | |||
|
|
|||
| * the `Python Packaging Index <https://pypi.org>`__ is a public | |||
| * The `Python Package Index <https://pypi.org>`__ is a public | |||
| .. _The .pypirc file: \ | ||
| https://packaging.python.org/specifications/pypirc/ | ||
|
|
||
|
|
||
| How do I...? | ||
| ============ | ||
| How do I… |
There was a problem hiding this comment.
I rarely see English speakers use this character; I use it in personal writing but not in the Python docs.
| On Linux systems, a Python installation will typically be included as part | ||
| of the distribution. Installing into this Python installation requires | ||
| On Linux, a Python installation will typically be included as part | ||
| of the Linux distribution. Installing into this Python installation requires |
| Python has typically relied heavily on source based distribution, with end | ||
| users being expected to compile extension modules from source as part of | ||
| Python has typically relied heavily on source based distributions, with end | ||
| users being expected to compile binary extensions from source as part of |
There was a problem hiding this comment.
extension modules is the way Python calls these (native code shared libraries built from other languages)
|
One wrong word is already fixed, the other things are too late or incorrect. Thanks but I’m rejected these changes. |
|
Fair enough. Thanks for the review. |
Changes to the Distributing Python Modules and Installing Python Modules documentation: