Repository navigation
Restore docstrings in ssl #126890
Copy link
Copy link
Closed
Labels
3.14bugs and security fixesbugs and security fixesextension-modulesC modules in the Modules dirC modules in the Modules dirtopic-SSLtype-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error
Description
Activity
- addedtype-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or errorextension-modulesC modules in the Modules dirC modules in the Modules dir3.14bugs and security fixesbugs and security fixes
on Nov 15, 2024 Related: #113160 (comment)
cpython/Tools/clinic/libclinic/parse_args.py
Lines 309 to 311 in 2313f84
elif self.func.kind is SETTER: if self.func.docstring: fail("docstrings are only supported for @getter, not @setter") I'm not certain how much needs to be restored
All of them, unless there's some specific reason not to. And even if then, they could be restored as comments.
Yeah, but I don't know how many docstrings there were originally yet.
@ZeroIntensity, are you still planning to add these back?
Yeah, but I don't know how many docstrings there were originally yet.
Nineteen or so:
$ git show 4c53b25 | grep '^-.*PyDoc' | wc -l 19I am! Sorry for the delay, I've gotten sidetracked with some other issues. I'll have plenty of time today to get this done.
Metadata
Metadata
Assignees
Labels
3.14bugs and security fixesbugs and security fixesextension-modulesC modules in the Modules dirC modules in the Modules dirtopic-SSLtype-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error
Bug report
Bug description:
As mentioned here, apparently I stripped some of the docstrings while switching things over to argument clinic in the big SSL thread safety fix (GH-124993).
I'm not certain how much needs to be restored, but I'll get to fixing this sometime this weekend or next week.
cc @JelleZijlstra, @neonene
CPython versions tested on:
3.14, CPython main branch
Operating systems tested on:
No response
Linked PRs
ssldocstrings #127281ssldocstrings (GH-127281) #127513