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

Improve clarity of signal.siginterrupt docs #69745

Open
TomMeagher mannequin opened this issue Nov 5, 2015 · 3 comments
Open

Improve clarity of signal.siginterrupt docs #69745

TomMeagher mannequin opened this issue Nov 5, 2015 · 3 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@TomMeagher
Copy link
Mannequin

TomMeagher mannequin commented Nov 5, 2015

BPO 25559
Nosy @vstinner, @bitdancer

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2015-11-05.16:54:37.756>
labels = ['type-feature', 'docs']
title = 'signal.siginterrupt description has typo'
updated_at = <Date 2015-11-05.20:30:22.448>
user = 'https://bugs.python.org/TomMeagher'

bugs.python.org fields:

activity = <Date 2015-11-05.20:30:22.448>
actor = 'vstinner'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2015-11-05.16:54:37.756>
creator = 'Tom Meagher'
dependencies = []
files = []
hgrepos = []
issue_num = 25559
keywords = []
message_count = 3.0
messages = ['254121', '254132', '254140']
nosy_count = 4.0
nosy_names = ['vstinner', 'r.david.murray', 'docs@python', 'Tom Meagher']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue25559'
versions = []

@TomMeagher
Copy link
Mannequin Author

TomMeagher mannequin commented Nov 5, 2015

"if flag is False, system calls will be restarted when interrupted by signal signalnum, otherwise system calls will be interrupted."

This sentence doesn't make any sense as written. I assume there should be a "not" in there somewhere, but I'm unclear if signal calls are not interrupted when the flag is false, or not interrupted when they are true.

@TomMeagher TomMeagher mannequin assigned docspython Nov 5, 2015
@TomMeagher TomMeagher mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Nov 5, 2015
@bitdancer
Copy link
Member

The first phase says "restarted when interrupted", the second phrase says "interrupted". So the difference is whether the system call is restarted or left in interrupted state (ie: the signal will propagate, which is confirmed by the second paragraph). I can't see a way to phrase it any more clearly, can you?

@vstinner
Copy link
Member

vstinner commented Nov 5, 2015

For more information on how Python handles signals, you can also read the PEP-475 (which changed how Python 3.5 handles signals ;-))

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
@erlend-aasland erlend-aasland changed the title signal.siginterrupt description has typo Improve clarity of signal.siginterrupt docs Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
None yet
Development

No branches or pull requests

2 participants