diff options
author | Paul Moore <p.f.moore@gmail.com> | 2014-04-03 14:06:29 +0100 |
---|---|---|
committer | Paul Moore <p.f.moore@gmail.com> | 2014-04-03 14:06:29 +0100 |
commit | 35dbd30e62779dab7ac660a37f8bf12c7a3c3bf9 (patch) | |
tree | 77206620bdfd0000eef354d36e4ebfcd1261ff73 | |
parent | 5a3d2b588c35cb218b2ddb11fc88345be4ba80d7 (diff) | |
download | wheel-35dbd30e62779dab7ac660a37f8bf12c7a3c3bf9.tar.gz |
Added some extra documentation for the --python-tag option (in prticular, the default value)
-rw-r--r-- | CHANGES.txt | 6 | ||||
-rw-r--r-- | docs/index.rst | 8 |
2 files changed, 14 insertions, 0 deletions
diff --git a/CHANGES.txt b/CHANGES.txt index d5b74e2..f9b9dd3 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,3 +1,9 @@ +0.24.0 +====== +- The python tag used for pure-python packages is now .pyN (major version + only). This change actually occurred in 0.23.0 when the --python-tag + option was added, but was not explicitly mentioned in the changelog then. + 0.23.0 ====== - Compatibiltiy tag flags added to the bdist_wheel command diff --git a/docs/index.rst b/docs/index.rst index 7575c40..fde43da 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -115,11 +115,19 @@ used to specify the Python version tag to use more precisely:: Neither of these two flags have any effect when used on a project that includes C extension code. +The default for a pure Python project (if no explicit flags are given) is "pyN" +where N is the major version of the Python interpreter used to build the wheel. +This is generally the correct choice, as projects would not typically ship +different wheels for different minor versions of Python. + A reasonable use of the `--python-tag` argument would be for a project that uses Python syntax only introduced in a particular Python version. There are no current examples of this, but if wheels had been available when Python 2.5 was released (the first version containing the `with` statement), wheels for a project that used the `with` statement would typically use `--python-tag py25`. +However, unless a separate version of the wheel was shipped which avoided the +use of the new syntax, there is little benefit in explicitly marking the tag in +this manner. Typically, projects would not specify Python tags on the command line, but would use `setup.cfg` to set them as a project default:: |