Skip to content

gh-103449: Fix a bug in dataclass docstring generation #103454

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 17, 2023
Merged

gh-103449: Fix a bug in dataclass docstring generation #103454

merged 1 commit into from
Apr 17, 2023

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Apr 11, 2023 •
edited by bedevere-bot
Loading

Now, we can use a default signature by catching some of the exceptions.
As the second option - we can catch all exceptions here.

@sobolevn sobolevn requested a review from ericvsmith as a code owner April 11, 2023 18:41
@bedevere-bot bedevere-bot mentioned this pull request Apr 11, 2023
Closed
@Eclips4
Copy link
Member

Eclips4 commented Apr 11, 2023

Thanks for fix, Nikita!
Also, this reproducible on 3.11, so, I think this should be merged to 3.11 and current branch.
(Although, reproducible on 3.9 & 3.10, but it's not a security fix)

@Eclips4
Copy link
Member

Eclips4 commented Apr 11, 2023

However, functional of Test.__doc__ (where Test is a dataclass) is not documented.

@carljm carljm added the needs backport to 3.11 only security fixes label Apr 17, 2023
@carljm carljm merged commit b57f55c into python:main Apr 17, 2023
@miss-islington
Copy link
Contributor

Thanks @sobolevn for the PR, and @carljm for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry @sobolevn and @carljm, I had trouble checking out the 3.11 backport branch.
Please retry by removing and re-adding the "needs backport to 3.11" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker b57f55c23e15654e9dd77680ff1462603e360b76 3.11

@carljm carljm added needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes labels Apr 17, 2023
@miss-islington
Copy link
Contributor

Thanks @sobolevn for the PR, and @carljm for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 17, 2023
@sobolevn @miss-islington
pythongh-103449: Fix a bug in dataclass docstring generation (pythonG…
daf990b 
…H-103454)

(cherry picked from commit b57f55c)

Co-authored-by: Nikita Sobolev <[email protected]>
@bedevere-bot
Copy link

GH-103599 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Apr 17, 2023
carljm pushed a commit that referenced this pull request Apr 23, 2023
@miss-islington
[3.11] gh-103449: Fix a bug in dataclass docstring generation (GH-103454
ec29d0c 
) (#103599)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carljm carljm carljm approved these changes

@prasahnt-pandey prasahnt-pandey prasahnt-pandey approved these changes

@ericvsmith ericvsmith Awaiting requested review from ericvsmith ericvsmith is a code owner

Assignees

@carljm carljm

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@sobolevn @Eclips4 @miss-islington @bedevere-bot @carljm @prasahnt-pandey