diff options
author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-06-16 14:38:47 +0100 |
---|---|---|
committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-06-16 14:38:47 +0100 |
commit | d738686eaa23c94e64e772331433692edbac75e9 (patch) | |
tree | 225ebee6b2f96c6ea35e5e4c52bedb08992dde05 /docs/userguide | |
parent | 6bd10b2cc1981174275c9e6a12e6808454d82a77 (diff) | |
download | python-setuptools-git-d738686eaa23c94e64e772331433692edbac75e9.tar.gz |
Add note about possible improvement
Diffstat (limited to 'docs/userguide')
-rw-r--r-- | docs/userguide/quickstart.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index b6cba48f..bd7951c0 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -138,6 +138,17 @@ we will walk through the additional but essential information you need to specify to properly package your project. +.. + TODO: A previous generation of this document included a section called + "Python packaging at a glance". This is a nice title, but the content + removed because it assumed the reader had familiarity with the history of + setuptools and PEP 517. We should take advantage of this nice title and add + this section back, but use it to explain important concepts of the + ecosystem, such as "sdist", "wheel", "index". It would also be nice if we + could have a diagram for that (explaining for example that "wheels" are + built from "sdists" not the source tree). + + Overview ======== |