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

Improve signal documentation #14274

Merged
merged 3 commits into from
Aug 6, 2019
Merged

Improve signal documentation #14274

merged 3 commits into from
Aug 6, 2019

Conversation

geryogam
Copy link
Contributor

@geryogam geryogam commented Jun 20, 2019 •
edited by miss-islington
Loading

  • add a missing .. availability:: reST explicit markup;
  • more consistent "see man page" sentences.

Automerge-Triggered-By: @Mariatta

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jun 20, 2019
mangrisano
mangrisano suggested changes Jun 20, 2019
View reviewed changes
Copy link
Contributor

@mangrisano mangrisano left a comment

Choose a reason for hiding this comment

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

Hi and thank you for the pull request.
I've left a suggestion about the changes.

Thanks a lot :)

Doc/library/signal.rst Outdated Show resolved Hide resolved
Mariatta
Mariatta reviewed Jun 20, 2019
View reviewed changes
Doc/library/signal.rst Outdated Show resolved Hide resolved
Mariatta
Mariatta requested changes Jun 20, 2019
View reviewed changes
Copy link
Member

@Mariatta Mariatta left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I think the change is generally fine. I just prefer if the sentences are without parenthesis.

@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.

@geryogam
Copy link
Contributor Author

I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@Mariatta: please review the changes made to this pull request.

@mangrisano
Copy link
Contributor

LGTM.

@geryogam
Copy link
Contributor Author

geryogam commented Aug 6, 2019

@Mariatta

@Mariatta
Copy link
Member

Mariatta commented Aug 6, 2019

Sorry for the delay in reviewing. I got a lot going on.

Looks good to me. Thanks!

@Mariatta Mariatta changed the title Update signal.rst Improve signal documentation Aug 6, 2019
@miss-islington
Copy link
Contributor

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

@miss-islington miss-islington merged commit cfebfef into python:master Aug 6, 2019
@miss-islington
Copy link
Contributor

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

@miss-islington
Copy link
Contributor

Thanks @maggyero for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 6, 2019
@geryogam @miss-islington
Improve signal documentation (pythonGH-14274)
81e4e30 
* add a missing ``.. availability::`` reST explicit markup;
* more consistent "see man page" sentences.
(cherry picked from commit cfebfef)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
@bedevere-bot
Copy link

GH-15151 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 Aug 6, 2019
@geryogam @miss-islington
Improve signal documentation (pythonGH-14274)
1b5aeb2 
* add a missing ``.. availability::`` reST explicit markup;
* more consistent "see man page" sentences.
(cherry picked from commit cfebfef)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
@bedevere-bot
Copy link

GH-15152 is a backport of this pull request to the 3.7 branch.

miss-islington added a commit that referenced this pull request Aug 6, 2019
@miss-islington @geryogam
Improve signal documentation (GH-14274)
ef0b819 
* add a missing ``.. availability::`` reST explicit markup;
* more consistent "see man page" sentences.
(cherry picked from commit cfebfef)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
miss-islington added a commit that referenced this pull request Aug 6, 2019
@miss-islington @geryogam
Improve signal documentation (GH-14274)
18343ab 
* add a missing ``.. availability::`` reST explicit markup;
* more consistent "see man page" sentences.
(cherry picked from commit cfebfef)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
@geryogam geryogam deleted the patch-8 branch August 7, 2019 05:30
@geryogam
Copy link
Contributor Author

geryogam commented Aug 7, 2019

Thanks for reviewing this @Mariatta.

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@geryogam @lisroach
Improve signal documentation (pythonGH-14274)
63d2b90 
* add a missing ``.. availability::`` reST explicit markup;
* more consistent "see man page" sentences.
This was referenced Sep 12, 2019
Merged
Merged
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@geryogam @DinoV
Improve signal documentation (pythonGH-14274)
d7781e4 
* add a missing ``.. availability::`` reST explicit markup;
* more consistent "see man page" sentences.
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
@geryogam @websurfer5
Improve signal documentation (pythonGH-14274)
16770e6 
* add a missing ``.. availability::`` reST explicit markup;
* more consistent "see man page" sentences.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mangrisano mangrisano mangrisano requested changes

@Mariatta Mariatta Mariatta approved these changes

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

Successfully merging this pull request may close these issues.
6 participants
@geryogam @bedevere-bot @mangrisano @Mariatta @miss-islington @the-knights-who-say-ni