Description

encukou

opened on Oct 5, 2022

Issue body actions

The members of PyMemberDef aren't marked up as members, so they can't be linked to individually.

Linked PRs

• gh-97909: Fix markup for PyMethodDef members #100089
• [3.11] gh-97909: Fix markup for PyMethodDef members (GH-100089) #100311
• [3.10] gh-97909: Fix markup for PyMethodDef members (GH-100089) #100312

Activity

1. encukou

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   easy

   on Oct 5, 2022
2. encukou commented on Oct 12, 2022

   

   encukou

   on Oct 12, 2022

   MemberAuthor

   More actions

   Reserving for a student. Everyone else, please don't start on this issue this week.

   ---

   You will want to click “Show Source” on the page linked in the first comment. That will take you to the place you need to edit on GitHub.

   You will also want to read the Devguide, for info like how to build the documentation with your changes: https://devguide.python.org/documentation/start-documenting/

   An example of how members should be documented is in PyType_Spec: https://docs.python.org/3/c-api/type.html#c.PyType_Spec
3. encukou

   removed

   easy

   on Oct 12, 2022
4. Johnny11502 commented on Oct 12, 2022

   

   Johnny11502

   on Oct 12, 2022

   Contributor

   More actions

   @encukou I would like to work on this issue. Thanks for the hint!

   Reacted by Petr Viktorin
5. Johnny11502 commented on Oct 14, 2022

   

   Johnny11502

   on Oct 14, 2022

   Contributor

   More actions

   @encukou Just to let you know, I did not forget about this issue and I have just been a bit busy at work this week. I will try and submit my PR tonight or tomorrow.
6. Johnny11502 commented on Oct 14, 2022

   

   Johnny11502

   on Oct 14, 2022

   Contributor

   More actions

   @encukou I am a bit confused about what needs to be marked up as a member under PyMemberDef. I looked at PyType_Spec and saw how PyType_Spec.name and the members that follow were documented but I do not see what would need it for this issue. Would you please be able to specify the lines or text that needs to be corrected.
7. encukou commented on Oct 17, 2022

   

   encukou

   on Oct 17, 2022

   MemberAuthor

   More actions

   The members (fields) are name, type, offset, etc. Currently they're defined in a table, so they don't show up when searching the docs for PyMemberDef.name (and when writing the docs, can't be linked using :c:member`PyMemberDef.name`).
   The table should be converted to entries for the individual members.
8. Johnny11502 commented on Oct 17, 2022

   

   Johnny11502

   on Oct 17, 2022

   Contributor

   More actions

   Got it, thanks!

   Reacted by Petr Viktorin
9. Johnny11502

   added a commit that references this issue on Oct 19, 2022

   pythonGH-97909 PyMemberDef members are not marked up

   4b31880
10. encukou

    added a commit that references this issue on Oct 24, 2022

    gh-97909: Mark up members of PyMemberDef (GH-98473)

    c237076
11. encukou

    changed the title [-]PyMemberDef members are not marked up[/-] [+]PyMemberDef & PyGetSetDef members are not marked up[/+] on Oct 24, 2022
12. encukou commented on Oct 24, 2022

    

    encukou

    on Oct 24, 2022

    MemberAuthor

    More actions

    PyGetSetDef is in the same situation, let's use this issue for that as well.
13. Johnny11502 commented on Oct 24, 2022

    

    Johnny11502

    on Oct 24, 2022

    Contributor

    More actions

    @encukou I can update the members of PyGetSetDef as well since it would pretty much be the same if you don't mind.
14. encukou commented on Oct 24, 2022

    

    encukou

    on Oct 24, 2022

    MemberAuthor

    More actions

    Sounds good, thanks!
15. 3 remaining items
16. encukou

    changed the title [-]PyMemberDef & PyGetSetDef members are not marked up[/-] [+]Some C struct members are not marked up in docs[/+] on Dec 6, 2022
17. encukou commented on Dec 6, 2022

    

    encukou

    on Dec 6, 2022

    MemberAuthor

    More actions

    PyMethodDef could use the same treatment.
18. encukou

    reopened this on Dec 6, 2022
19. encukou

    added a commit that references this issue on Dec 6, 2022

    Don't add "old" fragments for PyMemberDef and PyGetSetDef

    cc57955
20. ramvikrams commented on Dec 7, 2022

    

    ramvikrams

    on Dec 7, 2022

    Contributor

    More actions

    i'll do that
21. kumaraditya303

    added a commit that references this issue on Dec 17, 2022

    gh-97909: Fix markup for `PyMethodDef` members (#100089)

    8edcb30
22. miss-islington

    added 4 commits that reference this issue on Dec 17, 2022

    pythongh-97909: Fix markup for `PyMethodDef` members (pythonGH-100089)

    dc876bc

    pythongh-97909: Fix markup for `PyMethodDef` members (pythonGH-100089)

    a41ad32

    gh-97909: Fix markup for `PyMethodDef` members (GH-100089)

    370498b

    gh-97909: Fix markup for `PyMethodDef` members (GH-100089)

    e38a525
23. shihai1991

    added a commit that references this issue on Dec 18, 2022

    Merge remote-tracking branch 'origin/main' into bpo_34697

    2878571
24. carljm

    added a commit that references this issue on Dec 19, 2022

    Merge branch 'main' into fastmock

    a9af20a
25. hugovk commented on Jul 31, 2024

    

    hugovk

    on Jul 31, 2024

    Member

    More actions

    Triage: can this be closed?
26. ZeroIntensity commented on Jan 28, 2025

    

    ZeroIntensity

    on Jan 28, 2025

    Member

    More actions

    I'm pretty confident that this is done.
27. ZeroIntensity

    closed this as completedon Jan 28, 2025

Issue actions