Paul Moore  committed ea7a960

Added some extra documentation for the --python-tag option (in prticular, the default value)

  • Participants
  • Parent commits 668ef50
  • Branches pytag-doc-updates

Comments (0)

Files changed (2)

+- 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.
 - Compatibiltiy tag flags added to the bdist_wheel command

File docs/index.rst

 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::