Skip to content

Improve C-API doc for PyTypeObject #61247

Closed
Closed
Improve C-API doc for PyTypeObject#61247
Labels
3.7 (EOL)end of life3.8 (EOL)end of lifedocsDocumentation in the Doc dirtype-featureA feature request or enhancement

Description

@ericsnowcurrently
ericsnowcurrently
opened on Jan 27, 2013
BPO 17045
Nosy @ezio-melotti, @ericsnowcurrently, @berkerpeksag, @serhiy-storchaka, @csabella
PRs
  • bpo-17045: Improve C-API doc for PyTypeObject. #7413
    		•
    Files
  • typeobj-doc.diff
    		•

    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 2018-06-14.21:47:00.962>
created_at = <Date 2013-01-27.00:11:25.039>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'Improve C-API doc for PyTypeObject'
updated_at = <Date 2018-06-14.21:47:00.961>
user = 'https://github.com/ericsnowcurrently'

    bugs.python.org fields:

    activity = <Date 2018-06-14.21:47:00.961>
actor = 'eric.snow'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-06-14.21:47:00.962>
closer = 'eric.snow'
components = ['Documentation']
creation = <Date 2013-01-27.00:11:25.039>
creator = 'eric.snow'
dependencies = []
files = ['28865']
hgrepos = []
issue_num = 17045
keywords = ['patch']
message_count = 8.0
messages = ['180723', '180733', '318541', '318659', '318722', '318741', '319474', '319558']
nosy_count = 6.0
nosy_names = ['ezio.melotti', 'docs@python', 'eric.snow', 'berker.peksag', 'serhiy.storchaka', 'cheryl.sabella']
pr_nums = ['7413']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue17045'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']

    Activity

    1. ericsnowcurrently commented on Jan 27, 2013

      @ericsnowcurrently
      ericsnowcurrently
      on Jan 27, 2013
      MemberAuthor

      http://docs.python.org/dev/c-api/typeobj.html

      I found the the documentation for PyTypeObject to be somewhat harder to use than it need be. In the end I distilled the info down for my own use. I'm comfortable with what I came up with, so I'd like to at least add a condensed version of one or two of the tables I made to the top of the doc, with the slot names linking to each description as it currently exists. Attached is a patch.

      (I also plan on reformatting the doc source so the lines wrap better--70 columns or so.)

      As well, I have a couple open questions that I'll address separately:

      • should tp_del be added?
      • inheritance of tp_flags...
    2. ezio-melotti
      added
      docsDocumentation in the Doc dir
      on Jan 27, 2013
    3. ezio-melotti
      assigned
      docspython
      on Jan 27, 2013
    4. ezio-melotti
      added
      type-featureA feature request or enhancement
      on Jan 27, 2013

    5. ericsnowcurrently commented on Jan 27, 2013

      @ericsnowcurrently
      ericsnowcurrently
      on Jan 27, 2013
      MemberAuthor

      Here's an updated patch after feedback. Thanks Ezio!

    6. serhiy-storchaka commented on Jun 3, 2018

      @serhiy-storchaka
      serhiy-storchaka
      on Jun 3, 2018
      Member

      Do you mind to create a PR Eric?

    7. serhiy-storchaka
      added
      3.7 (EOL)end of life
      3.8 (EOL)end of life
      on Jun 3, 2018

    8. ericsnowcurrently commented on Jun 4, 2018

      @ericsnowcurrently
      ericsnowcurrently
      on Jun 4, 2018
      MemberAuthor

      I'll definitely take a look. It might not be until Friday though.

    9. ericsnowcurrently commented on Jun 5, 2018

      @ericsnowcurrently
      ericsnowcurrently
      on Jun 5, 2018
      MemberAuthor

      I found some time to at least get the patch to apply cleanly to master and to make a PR. :)

    10. csabella commented on Jun 5, 2018

      @csabella
      csabella
      on Jun 5, 2018
      Contributor

      This isn't directly related to this change, but I wanted to point out bpo-23869 since you seem to understand the topic enough to respond to that ticket.

      Thanks!

    11. ericsnowcurrently commented on Jun 13, 2018

      @ericsnowcurrently
      ericsnowcurrently
      on Jun 13, 2018
      MemberAuthor

      @cheryl, thanks for pointing that out. I'll take a look.

    12. ericsnowcurrently commented on Jun 14, 2018

      @ericsnowcurrently
      ericsnowcurrently
      on Jun 14, 2018
      MemberAuthor

      New changeset 9e7c921 by Eric Snow in branch 'master':
      bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413)
      9e7c921

    13. ericsnowcurrently
      closed this as completedon Jun 14, 2018
    14. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      3.7 (EOL)end of life3.8 (EOL)end of lifedocsDocumentation in the Doc dirtype-featureA feature request or enhancement

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions