Repository navigation
Some C struct members are not marked up in docs #97909
Description
Activity
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
@encukou I would like to work on this issue. Thanks for the hint!
Reacted by Petr Viktorin@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.
@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.
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.Got it, thanks!
Reacted by Petr Viktorin- added a commit that references this issue
on Oct 19, 2022 - added a commit that references this issue
on Oct 24, 2022 - changed the title
[-]PyMemberDef members are not marked up[/-][+]PyMemberDef & PyGetSetDef members are not marked up[/+]on Oct 24, 2022 PyGetSetDef is in the same situation, let's use this issue for that as well.
@encukou I can update the members of PyGetSetDef as well since it would pretty much be the same if you don't mind.
Sounds good, thanks!
3 remaining items
- changed the title
[-]PyMemberDef & PyGetSetDef members are not marked up[/-][+]Some C struct members are not marked up in docs[/+]on Dec 6, 2022 PyMethodDefcould use the same treatment.- added a commit that references this issue
on Dec 6, 2022 i'll do that
- added a commit that references this issue
on Dec 17, 2022 - added 4 commits that reference this issue
on Dec 17, 2022 - added a commit that references this issue
on Dec 18, 2022 - added a commit that references this issue
on Dec 19, 2022 Triage: can this be closed?
I'm pretty confident that this is done.
The members of PyMemberDef aren't marked up as members, so they can't be linked to individually.
Linked PRs
PyMethodDefmembers #100089PyMethodDefmembers (GH-100089) #100311PyMethodDefmembers (GH-100089) #100312