[Python-checkins] peps: PEP 440: Clarify admonitions are for releases, not local builds

nick.coghlan python-checkins at python.org
Thu Apr 16 01:06:11 CEST 2015


https://hg.python.org/peps/rev/bf4ffb364faf
changeset:   5757:bf4ffb364faf
user:        Nick Coghlan <ncoghlan at gmail.com>
date:        Wed Apr 15 19:05:55 2015 -0400
summary:
  PEP 440: Clarify admonitions are for releases, not local builds

files:
  pep-0440.txt |  16 ++++++++++------
  1 files changed, 10 insertions(+), 6 deletions(-)


diff --git a/pep-0440.txt b/pep-0440.txt
--- a/pep-0440.txt
+++ b/pep-0440.txt
@@ -159,8 +159,10 @@
 potentially backporting security and bug fixes from later versions of the
 upstream project.
 
-Local version identifiers SHOULD NOT be used for upstream projects. Local
-version identifiers SHOULD be used by dowstream projects when releasing a
+Local version identifiers SHOULD NOT be used when publishing upstream
+projects to a public index server, but MAY be used to identify private
+builds created directly from the project source. Local
+version identifiers SHOULD be used by downstream projects when releasing a
 version that is API compatible with the version of the upstream project
 identified by the public version identifier, but contains additional changes
 (such as bug fixes). As the Python Package Index is intended solely for
@@ -338,10 +340,12 @@
 
 .. note::
 
-   Creating developmental releases of pre-releases is strongly
-   discouraged, as it makes the version identifier difficult to parse for
-   human readers. In general, it is substantially clearer to simply create
-   additional pre-releases by incrementing the numeric component.
+   While they may be useful for continuous integration purposes, publishing
+   developmental releases of pre-releases to general purpose public index
+   servers is strongly discouraged, as it makes the version identifier
+   difficult to parse for human readers. If such a release needs to be
+   published, it is substantially clearer to instead create a new
+   pre-release by incrementing the numeric component.
 
    Developmental releases of post-releases are also strongly discouraged,
    but they may be appropriate for projects which use the post-release

-- 
Repository URL: https://hg.python.org/peps


More information about the Python-checkins mailing list