Repository navigation
Some C struct members are not marked up in docs #97909
Description
The members of PyMemberDef aren't marked up as members, so they can't be linked to individually.
The members of PyMemberDef aren't marked up as members, so they can't be linked to individually.
Activity
encukou commentedon Oct 12, 2022
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
Johnny11502 commentedon Oct 12, 2022
@encukou I would like to work on this issue. Thanks for the hint!
Johnny11502 commentedon Oct 14, 2022
@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.
Johnny11502 commentedon Oct 14, 2022
@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.
encukou commentedon Oct 17, 2022
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.
Johnny11502 commentedon Oct 17, 2022
Got it, thanks!
pythonGH-97909 PyMemberDef members are not marked up
gh-97909: Mark up members of PyMemberDef (GH-98473)
[-]PyMemberDef members are not marked up[/-][+]PyMemberDef & PyGetSetDef members are not marked up[/+]encukou commentedon Oct 24, 2022
PyGetSetDef is in the same situation, let's use this issue for that as well.
Johnny11502 commentedon Oct 24, 2022
@encukou I can update the members of PyGetSetDef as well since it would pretty much be the same if you don't mind.
encukou commentedon Oct 24, 2022
Sounds good, thanks!
3 remaining items
[-]PyMemberDef & PyGetSetDef members are not marked up[/-][+]Some C struct members are not marked up in docs[/+]encukou commentedon Dec 6, 2022
PyMethodDefcould use the same treatment.Don't add "old" fragments for PyMemberDef and PyGetSetDef
ramvikrams commentedon Dec 7, 2022
i'll do that
gh-97909: Fix markup for `PyMethodDef` members (#100089)
pythongh-97909: Fix markup for `PyMethodDef` members (pythonGH-100089)
pythongh-97909: Fix markup for `PyMethodDef` members (pythonGH-100089)
gh-97909: Fix markup for `PyMethodDef` members (GH-100089)
gh-97909: Fix markup for `PyMethodDef` members (GH-100089)
Merge remote-tracking branch 'origin/main' into bpo_34697
Merge branch 'main' into fastmock
hugovk commentedon Jul 31, 2024
Triage: can this be closed?
ZeroIntensity commentedon Jan 28, 2025
I'm pretty confident that this is done.