classification
Title: Mark up constants 0, 1, -1 in C API docs
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.7, Python 3.6, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: serhiy.storchaka Nosy List: matrixise, python-dev, serhiy.storchaka
Priority: normal Keywords: patch

Created on 2016-10-21 10:07 by serhiy.storchaka, last changed 2016-10-27 18:43 by serhiy.storchaka. This issue is now closed.

Files
File name Uploaded Description Edit
doc_consts_01.patch serhiy.storchaka, 2016-10-21 10:07 review
Messages (3)
msg279114 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2016-10-21 10:07
Proposed patch marks up constants 0, 1 and -1 (mostly return values) in C API documentation as literal test. Most occurrences already are marked up.

It also changes :const:`ULONG_MAX + 1` to ``ULONG_MAX + 1``, since this is not a constant name.
msg279135 - (view) Author: St├ęphane Wirtel (matrixise) * (Python committer) Date: 2016-10-21 15:28
Serhiy,

I think you can commit it.
msg279561 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-10-27 18:43
New changeset e90fe2209276 by Serhiy Storchaka in branch '2.7':
Issue #28496: Mark up constants 0, 1 and -1 that denote return values or
https://hg.python.org/cpython/rev/e90fe2209276

New changeset 04065efd7747 by Serhiy Storchaka in branch '3.5':
Issue #28496: Mark up constants 0, 1 and -1 that denote return values or
https://hg.python.org/cpython/rev/04065efd7747

New changeset de00be368f0b by Serhiy Storchaka in branch '3.6':
Issue #28496: Mark up constants 0, 1 and -1 that denote return values or
https://hg.python.org/cpython/rev/de00be368f0b

New changeset e19f2428b15a by Serhiy Storchaka in branch 'default':
Issue #28496: Mark up constants 0, 1 and -1 that denote return values or
https://hg.python.org/cpython/rev/e19f2428b15a
History
Date User Action Args
2016-10-27 18:43:51serhiy.storchakasetstatus: open -> closed
resolution: fixed
stage: commit review -> resolved
2016-10-27 18:43:20python-devsetnosy: + python-dev
messages: + msg279561
2016-10-21 15:28:56matrixisesetnosy: + matrixise

messages: + msg279135
stage: patch review -> commit review
2016-10-21 10:07:25serhiy.storchakacreate