Description

ZeroIntensity

opened on Nov 15, 2024

Issue body actions

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

• gh-126890: Restore stripped ssl docstrings #127281
• [3.13] gh-126890: Restore stripped ssl docstrings (GH-127281) #127513

Activity

1. ZeroIntensity

   added

   type-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error

   extension-modulesC modules in the Modules dirC modules in the Modules dir

   topic-SSL

   3.14bugs and security fixesbugs and security fixes

   on Nov 15, 2024
2. ZeroIntensity

   self-assigned this

   on Nov 15, 2024
3. neonene commented on Nov 16, 2024

   

   neonene

   on Nov 16, 2024

   Contributor

   More actions

   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")
4. JelleZijlstra commented on Nov 16, 2024

   

   JelleZijlstra

   on Nov 16, 2024

   Member

   More actions

   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.
5. ZeroIntensity commented on Nov 16, 2024

   

   ZeroIntensity

   on Nov 16, 2024

   MemberAuthor

   More actions

   Yeah, but I don't know how many docstrings there were originally yet.
6. encukou commented on Nov 25, 2024

   

   encukou

   on Nov 25, 2024

   Member

   More actions

   @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
   19
   
7. ZeroIntensity commented on Nov 25, 2024

   

   ZeroIntensity

   on Nov 25, 2024

   MemberAuthor

   More actions

   I am! Sorry for the delay, I've gotten sidetracked with some other issues. I'll have plenty of time today to get this done.
8. encukou

   added a commit that references this issue on Dec 2, 2024

   gh-126890: Restore stripped `ssl` docstrings (GH-127281)

   c112de1
9. encukou

   closed this as completedon Dec 2, 2024
10. ZeroIntensity

    added a commit that references this issue on Dec 2, 2024

    [3.13] pythongh-126890: Restore stripped `ssl` docstrings (pythonGH-1…

    f6584de
11. Yhg1s

    added a commit that references this issue on Dec 2, 2024

    [3.13] gh-126890: Restore stripped `ssl` docstrings (GH-127281) (#127513

    cab2ef5
12. srinivasreddy

    added a commit that references this issue on Jan 8, 2025

    pythongh-126890: Restore stripped `ssl` docstrings (pythonGH-127281)

    4a694af
13. ebonnal

    added a commit that references this issue on Jan 12, 2025

    pythongh-126890: Restore stripped `ssl` docstrings (pythonGH-127281)

    db48344

Issue actions