This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Change the mark up of NULL
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.9, Python 3.8, Python 3.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, serhiy.storchaka, shihai1991
Priority: normal Keywords: patch

Created on 2019-10-27 08:16 by serhiy.storchaka, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 16950 merged serhiy.storchaka, 2019-10-27 08:18
PR 16999 merged serhiy.storchaka, 2019-10-30 16:32
PR 17000 merged serhiy.storchaka, 2019-10-30 16:32
PR 17001 merged serhiy.storchaka, 2019-10-30 17:57
PR 17003 merged serhiy.storchaka, 2019-10-30 19:40
PR 17004 merged serhiy.storchaka, 2019-10-30 19:44
Messages (10)
msg355452 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-10-27 08:16
Currently NULL is mostly marked up as *NULL* in the C API documentation (although it is marked up as ``NULL`` outside of the C API documentation). It is rendered with italic font as function parameters and contradicts with formatting other macros and constants with monospace font.

The proposed PR replaces all *NULL* with ``NULL``.
msg355526 - (view) Author: Hai Shi (shihai1991) * (Python triager) Date: 2019-10-28 11:16
In  
'If *exc* is *NULL*, then the exception is cleared and the value is clipped to *PY_SSIZE_T_MIN* for a negative integer or *PY_SSIZE_T_MAX* for a positive integer.', should PY_SSIZE_T_MIN and PY_SSIZE_T_MAX be changed too?
msg355529 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-10-28 11:22
Yes of course, but I'll fix them in a separate PR. PR 16950 is mostly automatic replacements.
msg355538 - (view) Author: Hai Shi (shihai1991) * (Python triager) Date: 2019-10-28 12:48
Ok, it's fine to me.
msg355702 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-10-30 10:03
New changeset 25fc088607c855060ed142296dc1bd0125fad1af by Serhiy Storchaka in branch 'master':
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950)
https://github.com/python/cpython/commit/25fc088607c855060ed142296dc1bd0125fad1af
msg355727 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-10-30 19:36
New changeset 7f7f986cc485c40d80bae504333e3946ce9e96ba by Serhiy Storchaka in branch '3.7':
[3.7] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-17000)
https://github.com/python/cpython/commit/7f7f986cc485c40d80bae504333e3946ce9e96ba
msg355728 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-10-30 19:36
New changeset f2ba17be2aec873741c2d8a55b1342afa360aec2 by Serhiy Storchaka in branch '3.8':
[3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999)
https://github.com/python/cpython/commit/f2ba17be2aec873741c2d8a55b1342afa360aec2
msg355730 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-10-30 19:37
New changeset e835b31d2b212c3c7820364398979cae2a9740b2 by Serhiy Storchaka in branch 'master':
bpo-38600: NULL -> ``NULL``. (GH-17001)
https://github.com/python/cpython/commit/e835b31d2b212c3c7820364398979cae2a9740b2
msg355734 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-10-30 20:45
New changeset 2c921c65e9d0aa7e3a38c96a22d5eec56724da72 by Serhiy Storchaka in branch '3.8':
[3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003)
https://github.com/python/cpython/commit/2c921c65e9d0aa7e3a38c96a22d5eec56724da72
msg355735 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-10-30 20:45
New changeset 951b6c314a8567be3b5d901059fde866c79f5ff0 by Serhiy Storchaka in branch '3.7':
[3.7] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17004)
https://github.com/python/cpython/commit/951b6c314a8567be3b5d901059fde866c79f5ff0
History
Date User Action Args
2022-04-11 14:59:22adminsetgithub: 82781
2019-10-31 10:41:40serhiy.storchakasetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2019-10-30 20:45:17serhiy.storchakasetmessages: + msg355735
2019-10-30 20:45:00serhiy.storchakasetmessages: + msg355734
2019-10-30 19:44:35serhiy.storchakasetpull_requests: + pull_request16531
2019-10-30 19:40:24serhiy.storchakasetpull_requests: + pull_request16530
2019-10-30 19:37:21serhiy.storchakasetmessages: + msg355730
2019-10-30 19:36:38serhiy.storchakasetmessages: + msg355728
2019-10-30 19:36:33serhiy.storchakasetmessages: + msg355727
2019-10-30 17:57:18serhiy.storchakasetpull_requests: + pull_request16528
2019-10-30 16:32:28serhiy.storchakasetpull_requests: + pull_request16527
2019-10-30 16:32:09serhiy.storchakasetpull_requests: + pull_request16526
2019-10-30 10:03:27serhiy.storchakasetmessages: + msg355702
2019-10-28 12:48:32shihai1991setmessages: + msg355538
2019-10-28 11:22:28serhiy.storchakasetmessages: + msg355529
2019-10-28 11:16:51shihai1991setnosy: + shihai1991
messages: + msg355526
2019-10-27 08:18:45serhiy.storchakasetkeywords: + patch
stage: patch review
pull_requests: + pull_request16478
2019-10-27 08:16:09serhiy.storchakacreate