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.

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

bpo-41199: Docstring convention not followed for dataclasses documentation page #21413

Merged
merged 3 commits into from
Jul 9, 2020
Merged

bpo-41199: Docstring convention not followed for dataclasses documentation page #21413

merged 3 commits into from
Jul 9, 2020

Conversation

archsyscall
Copy link
Contributor

@archsyscall archsyscall commented Jul 9, 2020 •
edited by miss-islington
Loading

@archsyscall archsyscall requested a review from ericvsmith as a code owner July 9, 2020 11:18
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jul 9, 2020
@ericvsmith ericvsmith self-assigned this Jul 9, 2020
ericvsmith
ericvsmith requested changes Jul 9, 2020
View reviewed changes
Copy link
Member

@ericvsmith ericvsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this change is important enough for a News entry. So if you delete that, I'll go ahead and accept the change.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

ericvsmith
ericvsmith approved these changes Jul 9, 2020
View reviewed changes
Copy link
Member

@ericvsmith ericvsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@archsyscall
Copy link
Contributor Author

archsyscall commented Jul 9, 2020 •
edited
Loading

@ericvsmith
I deleted NEWS. Actually, I don't know what NEWS file is yet. I wrote this file just because of the failure test.

Could you please tell me what NEWS is?

I've read most of the guides for contribution, but since i just joined cpython, so I'm not used to everything yet.

I'm really sorry to bother you. 😢

@miss-islington
Copy link
Contributor

@marload: Status check is done, and it's a success ✅ .

@miss-islington miss-islington merged commit 61bb24a into python:master Jul 9, 2020
@miss-islington
Copy link
Contributor

Thanks @marload for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 9, 2020
@archsyscall @miss-islington
bpo-41199: Docstring convention not followed for dataclasses document…
11b4b78 
…ation page (pythonGH-21413)

Automerge-Triggered-By: @ericvsmith
(cherry picked from commit 61bb24a)

Co-authored-by: marload <rladhkstn8@gmail.com>
@bedevere-bot
Copy link

GH-21414 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Jul 9, 2020
@bedevere-bot
Copy link

GH-21415 is a backport of this pull request to the 3.8 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 9, 2020
@archsyscall @miss-islington
bpo-41199: Docstring convention not followed for dataclasses document…
d3c628b 
…ation page (pythonGH-21413)

Automerge-Triggered-By: @ericvsmith
(cherry picked from commit 61bb24a)

Co-authored-by: marload <rladhkstn8@gmail.com>
@archsyscall archsyscall deleted the fix-issue-41199 branch July 9, 2020 12:15
@ericvsmith
Copy link
Member

No worries. The News entries are how we keep track of what bugs have been fixed or features have been added. For a change like this, there's no reason to clutter the News entries.

miss-islington added a commit that referenced this pull request Jul 9, 2020
@miss-islington @archsyscall
bpo-41199: Docstring convention not followed for dataclasses document…
b4beda1 
…ation page (GH-21413)

Automerge-Triggered-By: @ericvsmith
(cherry picked from commit 61bb24a)

Co-authored-by: marload <rladhkstn8@gmail.com>
miss-islington added a commit that referenced this pull request Jul 9, 2020
@miss-islington @archsyscall
bpo-41199: Docstring convention not followed for dataclasses document…
1e66f7e 
…ation page (GH-21413)

Automerge-Triggered-By: @ericvsmith
(cherry picked from commit 61bb24a)

Co-authored-by: marload <rladhkstn8@gmail.com>
@archsyscall
Copy link
Contributor Author

Thank you for your kind reply.

This PR is my first contribution that merged to cpython/master.
So thank you more for your answer.

@ericvsmith
Copy link
Member

Thank you for your contribution!

arun-mani-j pushed a commit to arun-mani-j/cpython that referenced this pull request Jul 21, 2020
@archsyscall @arun-mani-j
bpo-41199: Docstring convention not followed for dataclasses document…
16210fd 
…ation page (pythonGH-21413)

Automerge-Triggered-By: @ericvsmith
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Aug 20, 2020
@archsyscall @shihai1991
bpo-41199: Docstring convention not followed for dataclasses document…
10ddc13 
…ation page (pythonGH-21413)

Automerge-Triggered-By: @ericvsmith
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericvsmith ericvsmith ericvsmith approved these changes

Assignees

@ericvsmith ericvsmith

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@archsyscall @bedevere-bot @miss-islington @ericvsmith @the-knights-who-say-ni