classification
Title: [EASY][doc] Document that signal.set_wakeup_fd(-1), unregister the previsouly set wakeup FD
Type: Stage: resolved
Components: Documentation Versions: Python 3.7, Python 3.6, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, pitrou, vstinner
Priority: normal Keywords: easy

Created on 2017-06-13 07:45 by vstinner, last changed 2017-06-13 08:38 by pitrou. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 2149 merged pitrou, 2017-06-13 08:17
PR 2140 merged pitrou, 2017-06-13 08:18
PR 2150 merged pitrou, 2017-06-13 08:18
PR 2151 merged pitrou, 2017-06-13 08:18
Messages (3)
msg295859 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2017-06-13 07:48
The signal.set_wakeup_fd() function is used to write signal numbers as bytes into a pipe, to be able to handle signals using a "regular" file descriptors instead of special signal handlers.

https://docs.python.org/dev/library/signal.html

Problem: it's not documented how to unregister the FD. I just saw "signal.set_wakeup_fd(-1)" in a Pull Request and realized that we forgot to document it:
https://github.com/python/cpython/pull/2139/

This issue is an EASY issue: please leave it to real newcomers who didn't write any PR to CPython previously. Core developers: explain how to fix the issue, don't fix it ;-)

Doc/library/signal.rst should be modified. I read that it's even possible to create a PR using an online editor? I never tried:
https://github.com/python/cpython/blob/master/Doc/library/signal.rst
msg295863 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2017-06-13 08:19
> This issue is an EASY issue: please leave it to real newcomers who didn't write any PR to CPython previously. Core developers: explain how to fix the issue, don't fix it ;-)

Too late, sorry!
msg295864 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2017-06-13 08:20
> This issue is an EASY issue: please leave it to real newcomers who didn't write any PR to CPython previously. Core developers: explain how to fix the issue, don't fix it ;-)

Oh wait, it seems like the core developer Antoine Pitrou fixed the issue before I created it! => commit d79c1d4a9406384f10a37f26a7515ce79f9fdd78

He already created 3 PR to backport the doc enhancement to 2.7, 3.5 and 3.6 branches.

Sorry!
History
Date User Action Args
2017-06-13 08:38:21pitrousetstatus: open -> closed
stage: resolved
resolution: fixed
versions: + Python 2.7, Python 3.5, Python 3.6
2017-06-13 08:20:16vstinnersetmessages: + msg295864
2017-06-13 08:19:27pitrousetnosy: + pitrou
messages: + msg295863
2017-06-13 08:18:59pitrousetpull_requests: + pull_request2203
2017-06-13 08:18:54pitrousetpull_requests: + pull_request2202
2017-06-13 08:18:22pitrousetpull_requests: + pull_request2201
2017-06-13 08:17:59pitrousetpull_requests: + pull_request2200
2017-06-13 07:48:51vstinnersetmessages: + msg295859
2017-06-13 07:46:00vstinnercreate