diff --git a/pep-0386.txt b/pep-0386.txt index c33b00ed2..de4c90eff 100644 --- a/pep-0386.txt +++ b/pep-0386.txt @@ -96,10 +96,10 @@ numbers, the two major ones are: Distutils --------- -Distutils currently provides a `StrictVersion` and a `LooseVersion` class +Distutils currently provides a ``StrictVersion`` and a ``LooseVersion`` class that can be used to manage versions. -The `LooseVersion` class is quite lax. From Distutils doc:: +The ``LooseVersion`` class is quite lax. From Distutils doc:: Version numbering for anarchists and software realists. Implements the standard interface for version number classes as @@ -146,9 +146,9 @@ nesting level it doesn't allow giving special meaning to versions (pre and post-releases as well as development versions), as expressed in requisites 2, 3 and 4. -The `StrictVersion` class is more strict. From the doc:: +The ``StrictVersion`` class is more strict. From the doc:: - Version numbering for meticulous retentive and software idealists. + Version numbering for meticulous retentive and software idealists. Implements the standard interface for version number classes as described above. A version number consists of two or three dot-separated numeric components, with an optional "pre-release" tag @@ -196,7 +196,7 @@ It adds pre-release versions, and some structure, but lacks a few semantic elements to make it usable, such as development releases or post-release tags, as expressed in requisites 3 and 4. -Also, note that Distutils version classes have been present since years +Also, note that Distutils version classes have been present for years but are not really used in the community. @@ -204,7 +204,7 @@ Setuptools ---------- Setuptools provides another version comparison tool [#setuptools-version]_ -which does not enforce any rules for the version, but try to provide a better +which does not enforce any rules for the version, but tries to provide a better algorithm to convert the strings to sortable keys, with a ``parse_version`` function. @@ -279,7 +279,7 @@ Also there's a problem with the use of dates at the "major" version number switch to a more typical "major.minor..." version scheme is problematic because it will always sort less than "20090421". -Last, the meaning of `-` is specific to Setuptools, while it is avoided in +Last, the meaning of ``-`` is specific to Setuptools, while it is avoided in some packaging systems like the one used by Debian or Ubuntu. The new versioning algorithm @@ -347,7 +347,7 @@ scheme. ``rc`` sorts after ``c``:: ... < V('1.0b3') ... < V('1.0c1') ... < V('1.0rc2') - ... < V('1.0') + ... < V('1.0')) True ``verlib`` provides a ``NormalizedVersion`` class and a @@ -402,9 +402,9 @@ normalized (i.e. ``NormalizedVersion`` doesn't like it) then you might be able to get an equivalent (or close) normalized version from this function. This does a number of simple normalizations to the given string, based -on observation of versions currently in use on PyPI. +on an observation of versions currently in use on PyPI. -Given a dump of those version on January 6th 2010, the function has given those +Given a dump of those versions on January 6th 2010, the function has given those results out of the 8821 distributions PyPI had: - 7822 (88.67%) already match ``NormalizedVersion`` without any change @@ -425,11 +425,11 @@ version schemes, versions with custom markers, or dummy versions. Examples: When a tool needs to work with versions, a strategy is to use ``suggest_normalized_version`` on the versions string. If this function returns ``None``, it means that the provided version is not close enough to the -standard scheme. If it returns a version that slighlty differs from +standard scheme. If it returns a version that slightly differs from the original version, it's a suggested normalized version. Last, if it returns the same string, it means that the version matches the scheme. -Here's an example of usage :: +Here's an example of usage:: >>> from verlib import suggest_normalized_version, NormalizedVersion >>> import warnings