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 | ec60dd2a1ca2809d634a8bedacc8ae9daefbbac1 (patch) | |
| tree | 77206620bdfd0000eef354d36e4ebfcd1261ff73 /docs/index.rst | |
| parent | 75c59f175c8cb2bfcb6660927232b40df1e149c4 (diff) | |
| download | wheel-git-ec60dd2a1ca2809d634a8bedacc8ae9daefbbac1.tar.gz | |
Added some extra documentation for the --python-tag option (in prticular, the default value)
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 8 |
1 files changed, 8 insertions, 0 deletions
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:: |
