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.

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

PyObject_Malloc is not documented #64263

Closed
bitdancer opened this issue Dec 24, 2013 · 9 comments
Closed

PyObject_Malloc is not documented #64263

bitdancer opened this issue Dec 24, 2013 · 9 comments
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) type-bug An unexpected behavior, bug, or error

Comments

@bitdancer
Copy link
Member

BPO 20064
Nosy @vstinner, @bitdancer, @zware, @willingc
PRs
  • bpo-20064: Document PyObject_Malloc() #4199
  • [3.6] bpo-20064: Document PyObject_Malloc() (GH-4199) #4203
  • [2.7] bpo-20064: Document PyObject_Malloc() #4204
  • Files
  • 20064.patch
  • 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 2017-10-31.17:09:18.353>
    created_at = <Date 2013-12-24.19:39:20.554>
    labels = ['interpreter-core', 'type-bug', '3.7', 'docs']
    title = 'PyObject_Malloc is not documented'
    updated_at = <Date 2017-10-31.17:09:18.344>
    user = 'https://github.com/bitdancer'

    bugs.python.org fields:

    activity = <Date 2017-10-31.17:09:18.344>
    actor = 'vstinner'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2017-10-31.17:09:18.353>
    closer = 'vstinner'
    components = ['Documentation', 'Interpreter Core']
    creation = <Date 2013-12-24.19:39:20.554>
    creator = 'r.david.murray'
    dependencies = []
    files = ['33261']
    hgrepos = []
    issue_num = 20064
    keywords = ['patch']
    message_count = 9.0
    messages = ['206910', '206914', '223328', '223424', '223593', '305313', '305315', '305317', '305318']
    nosy_count = 7.0
    nosy_names = ['vstinner', 'r.david.murray', 'docs@python', 'BreamoreBoy', 'gennad', 'zach.ware', 'willingc']
    pr_nums = ['4199', '4203', '4204']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue20064'
    versions = ['Python 2.7', 'Python 3.6', 'Python 3.7']

    @bitdancer
    Copy link
    Member Author

    At least, a doc ref to :c:func:`PyObject_Malloc` does not turn into a link, and I can't find anything in the docs that it looks like it should link to.

    @bitdancer bitdancer added docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) type-bug An unexpected behavior, bug, or error labels Dec 24, 2013
    @gennad
    Copy link
    Mannequin

    gennad mannequin commented Dec 25, 2013

    Hi,

    I created the patch, please kindly review it, all comments are welcomed.

    Thank you!

    @BreamoreBoy
    Copy link
    Mannequin

    BreamoreBoy mannequin commented Jul 17, 2014

    As the patch is short can we have a commit review please. Can we also close bpo-18392 as a duplicate of this.

    @willingc
    Copy link
    Contributor

    I've reviewed this patch. It's my first patch review for this project so I'm not sure that I submitted the review correctly in Rietveld.

    @zware
    Copy link
    Member

    zware commented Jul 21, 2014

    It appears that PyObject_Realloc and PyObject_Free are also not documented; they should be along with PyObject_Malloc.

    I also left a couple of comments on Rietveld.

    @vstinner
    Copy link
    Member

    New changeset ec2cbdd by Victor Stinner in branch 'master':
    bpo-20064: Document PyObject_Malloc() (bpo-4199)
    ec2cbdd

    @vstinner
    Copy link
    Member

    New changeset 8543ce8 by Victor Stinner (Miss Islington (bot)) in branch '3.6':
    bpo-20064: Document PyObject_Malloc() (GH-4199) (bpo-4203)
    8543ce8

    @vstinner
    Copy link
    Member

    New changeset 52ba7b4 by Victor Stinner in branch '2.7':
    bpo-20064: Document PyObject_Malloc() (bpo-4204)
    52ba7b4

    @vstinner
    Copy link
    Member

    It took a while, but PyObject_Malloc() & cie are now documented :-)

    I even backported and *adapted* the doc to Python 2.7 ;-)

    @vstinner vstinner added the 3.7 (EOL) end of life label Oct 31, 2017
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.7 (EOL) end of life docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Development

    No branches or pull requests

    4 participants