PEP 440: Clarify admonitions are for releases, not local builds

This commit is contained in:
Nick Coghlan 2015-04-15 19:05:55 -04:00
parent 076d085a26
commit 827fb2d6e7
1 changed files with 10 additions and 6 deletions

View File

@ -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 potentially backporting security and bug fixes from later versions of the
upstream project. upstream project.
Local version identifiers SHOULD NOT be used for upstream projects. Local Local version identifiers SHOULD NOT be used when publishing upstream
version identifiers SHOULD be used by dowstream projects when releasing a 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 version that is API compatible with the version of the upstream project
identified by the public version identifier, but contains additional changes identified by the public version identifier, but contains additional changes
(such as bug fixes). As the Python Package Index is intended solely for (such as bug fixes). As the Python Package Index is intended solely for
@ -338,10 +340,12 @@ post-releases::
.. note:: .. note::
Creating developmental releases of pre-releases is strongly While they may be useful for continuous integration purposes, publishing
discouraged, as it makes the version identifier difficult to parse for developmental releases of pre-releases to general purpose public index
human readers. In general, it is substantially clearer to simply create servers is strongly discouraged, as it makes the version identifier
additional pre-releases by incrementing the numeric component. 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, Developmental releases of post-releases are also strongly discouraged,
but they may be appropriate for projects which use the post-release but they may be appropriate for projects which use the post-release