Change the mark up of NULL

[serhiy-storchaka]

BPO	38600
Nosy	@serhiy-storchaka, @shihai1991
PRs	bpo-38600: Change the mark up of NULL in the C API documentation. #16950 [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) #16999 [3.7] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) #17000 bpo-38600: NULL -> NULL. #17001 [3.8] bpo-38600: NULL -> NULL. (GH-17001) #17003 [3.7] bpo-38600: NULL -> NULL. (GH-17001) #17004

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-10-31.10:41:40.679>
created_at = <Date 2019-10-27.08:16:09.679>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Change the mark up of NULL'
updated_at = <Date 2019-10-31.10:41:40.678>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2019-10-31.10:41:40.678>
actor = 'serhiy.storchaka'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-10-31.10:41:40.679>
closer = 'serhiy.storchaka'
components = ['Documentation']
creation = <Date 2019-10-27.08:16:09.679>
creator = 'serhiy.storchaka'
dependencies = []
files = []
hgrepos = []
issue_num = 38600
keywords = ['patch']
message_count = 10.0
messages = ['355452', '355526', '355529', '355538', '355702', '355727', '355728', '355730', '355734', '355735']
nosy_count = 3.0
nosy_names = ['docs@python', 'serhiy.storchaka', 'shihai1991']
pr_nums = ['16950', '16999', '17000', '17001', '17003', '17004']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue38600'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

[serhiy-storchaka]

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.

[shihai1991]

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?

[serhiy-storchaka]

Yes of course, but I'll fix them in a separate PR. PR 16950 is mostly automatic replacements.

[shihai1991]

Ok, it's fine to me.

[serhiy-storchaka]

New changeset 25fc088 by Serhiy Storchaka in branch 'master':
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950)
25fc088

[serhiy-storchaka]

New changeset 7f7f986 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)
7f7f986

[serhiy-storchaka]

New changeset f2ba17b 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)
f2ba17b

[serhiy-storchaka]

New changeset e835b31 by Serhiy Storchaka in branch 'master':
bpo-38600: NULL -> NULL. (GH-17001)
e835b31

[serhiy-storchaka]

New changeset 2c921c6 by Serhiy Storchaka in branch '3.8':
[3.8] bpo-38600: NULL -> NULL. (GH-17001) (GH-17003)
2c921c6