Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change the mark up of NULL #82781

Closed
serhiy-storchaka opened this issue Oct 27, 2019 · 10 comments
Closed

Change the mark up of NULL #82781

serhiy-storchaka opened this issue Oct 27, 2019 · 10 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@serhiy-storchaka
Copy link
Member

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
    Copy link
    Member Author

    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.

    @serhiy-storchaka serhiy-storchaka added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Oct 27, 2019
    @serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Oct 27, 2019
    @shihai1991
    Copy link
    Member

    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
    Copy link
    Member Author

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

    @shihai1991
    Copy link
    Member

    Ok, it's fine to me.

    @serhiy-storchaka
    Copy link
    Member Author

    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
    Copy link
    Member Author

    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
    Copy link
    Member Author

    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
    Copy link
    Member Author

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

    @serhiy-storchaka
    Copy link
    Member Author

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

    @serhiy-storchaka
    Copy link
    Member Author

    New changeset 951b6c3 by Serhiy Storchaka in branch '3.7':
    [3.7] bpo-38600: NULL -> NULL. (GH-17001) (GH-17004)
    951b6c3

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    AA-Turner pushed a commit to AA-Turner/devguide that referenced this issue Sep 13, 2023
    @serhiy-storchaka
    bpo-38600: NULL -> NULL. (python/cpython#17001)
    50f60a4 
    Also fix some other formatting.

GitHub-Issue-Link: python/cpython#82781
    erlend-aasland pushed a commit to python/devguide that referenced this issue Sep 26, 2023
    @serhiy-storchaka @erlend-aasland
    bpo-38600: NULL -> NULL. (python/cpython#17001)
    a069554 
    Also fix some other formatting.

GitHub-Issue-Link: python/cpython#82781
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @serhiy-storchaka @shihai1991