From 827fb2d6e72bcd9685186157652ef418c6f70057 Mon Sep 17 00:00:00 2001 From: Nick Coghlan Date: Wed, 15 Apr 2015 19:05:55 -0400 Subject: [PATCH] PEP 440: Clarify admonitions are for releases, not local builds --- pep-0440.txt | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/pep-0440.txt b/pep-0440.txt index 6757b8400..79739144c 100644 --- a/pep-0440.txt +++ b/pep-0440.txt @@ -159,8 +159,10 @@ An "upstream project" is a project that defines its own public versions. A 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 @@ post-releases:: .. 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