Skip to content

Restore docstrings in ssl #126890

Description

@ZeroIntensity

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

Activity

  1. neonene commented on Nov 16, 2024

    @neonene
    Contributor

    Related: #113160 (comment)

    elif self.func.kind is SETTER:
    if self.func.docstring:
    fail("docstrings are only supported for @getter, not @setter")

  2. JelleZijlstra commented on Nov 16, 2024

    @JelleZijlstra
    Member

    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.

  3. ZeroIntensity commented on Nov 16, 2024

    @ZeroIntensity
    MemberAuthor

    Yeah, but I don't know how many docstrings there were originally yet.

  4. encukou commented on Nov 25, 2024

    @encukou
    Member

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

    @ZeroIntensity
    MemberAuthor

    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.

  6. added a commit that references this issue on Dec 2, 2024
  7. added a commit that references this issue on Dec 2, 2024
  8. added a commit that references this issue on Dec 2, 2024
  9. added a commit that references this issue on Jan 8, 2025
  10. added a commit that references this issue on Jan 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

3.14bugs and security fixesextension-modulesC modules in the Modules dirtopic-SSLtype-bugAn unexpected behavior, bug, or error

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions