[docs] Improved documentation for C API version info (issue 15465)

kushaldas at gmail.com kushaldas at gmail.com
Wed Feb 27 11:23:00 CET 2013


http://bugs.python.org/review/15465/diff/7486/Doc/c-api/apiabiversion.rst
File Doc/c-api/apiabiversion.rst (right):

http://bugs.python.org/review/15465/diff/7486/Doc/c-api/apiabiversion.rst#newcode11
Doc/c-api/apiabiversion.rst:11: then that module will work on the future
Python releases but not on the older
On 2013/02/27 08:15:20, ezio.melotti wrote:
> Is the fact that it won't work enforced (e.g. does it fail when the
version is
> not valid)?  If not I would use a less strong wording, say that it
might not
> work on earlier versions.
They will fail to load, I will make the required changes.

http://bugs.python.org/review/15465/diff/7486/Doc/c-api/apiabiversion.rst#newcode14
Doc/c-api/apiabiversion.rst:14: For example if the PY_VERSION_HEX is set
to 0x030400a2, the underlying
On 2013/02/27 08:15:20, ezio.melotti wrote:
> ``PY_VERSION_HEX`` and ``0x030400a2``.

Ok, will also make this change.

http://bugs.python.org/review/15465/diff/7486/Doc/c-api/apiabiversion.rst#newcode19
Doc/c-api/apiabiversion.rst:19: | Bits (big endian order) | Meaning     
                                  |
On 2013/02/27 08:15:20, ezio.melotti wrote:
> I would use bytes here (and then group the last two in a single
entry).
I followed the explanation in the same way it is done in
http://docs.python.org/3.4/library/sys.html#sys.hexversion

http://bugs.python.org/review/15465/diff/7486/Doc/c-api/apiabiversion.rst#newcode21
Doc/c-api/apiabiversion.rst:21: | :const:`1-8`            | 
``PY_MAJOR_VERSION``  (the ``3`` in           |
On 2013/02/27 08:15:20, ezio.melotti wrote:
> Double space.

Ok.

http://bugs.python.org/review/15465/diff/7486/Doc/c-api/apiabiversion.rst#newcode27
Doc/c-api/apiabiversion.rst:27: | :const:`17-24`          | 
``PY_MICRO_VERSION``  (the ``0`` in           |
On 2013/02/27 08:15:20, ezio.melotti wrote:
> Maybe use 01, so it avoids confusion with the other zeros.

Ok, will change the example accordingly.

http://bugs.python.org/review/15465/


More information about the docs mailing list