Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore docstrings in ssl #126890

Closed
ZeroIntensity opened this issue Nov 15, 2024 · 5 comments
Closed

Restore docstrings in ssl #126890

ZeroIntensity opened this issue Nov 15, 2024 · 5 comments
Assignees
Labels
3.14 new features, bugs and security fixes extension-modules C modules in the Modules dir topic-SSL type-bug An unexpected behavior, bug, or error

Comments

@ZeroIntensity
Copy link
Member

ZeroIntensity commented Nov 15, 2024

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

@ZeroIntensity ZeroIntensity added type-bug An unexpected behavior, bug, or error extension-modules C modules in the Modules dir topic-SSL 3.14 new features, bugs and security fixes labels Nov 15, 2024
@ZeroIntensity ZeroIntensity self-assigned this Nov 15, 2024
@neonene
Copy link
Contributor

neonene commented Nov 16, 2024

Related: #113160 (comment)

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

@JelleZijlstra
Copy link
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.

@ZeroIntensity
Copy link
Member Author

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

@encukou
Copy link
Member

encukou commented Nov 25, 2024

@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

@ZeroIntensity
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.14 new features, bugs and security fixes extension-modules C modules in the Modules dir topic-SSL type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

4 participants