[Python-checkins] Add note to Queue.get() docs about block=True (GH-2223) (GH-12538)

[Raymond Hettinger]

https://github.com/python/cpython/commit/f3c5535f63e7cd49166ab33b7b0ebb3285ef4ed0
commit: f3c5535f63e7cd49166ab33b7b0ebb3285ef4ed0
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Raymond Hettinger <rhettinger at users.noreply.github.com>
date: 2019-03-25T13:03:16-07:00
summary:

Add note to Queue.get() docs about block=True (GH-2223) (GH-12538)

(cherry picked from commit 713a8ae7926472b02ee1a394633eb54aaa7912d1)

Co-authored-by: Stephen Rosen <sirosen at globus.org>

files:
M Doc/library/queue.rst

diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst
index 7335a64bef84..0a42da1d74a4 100644
--- a/Doc/library/queue.rst
+++ b/Doc/library/queue.rst
@@ -152,6 +152,11 @@ provide the public methods described below.
    Otherwise (*block* is false), return an item if one is immediately available,
    else raise the :exc:`Empty` exception (*timeout* is ignored in that case).
 
+   Prior to 3.0 on POSIX systems, and for all versions on Windows, if
+   *block* is true and *timeout* is ``None``, this operation goes into
+   an uninterruptible wait on an underlying lock. This means that no exceptions
+   can occur, and in particular a SIGINT will not trigger a :exc:`KeyboardInterrupt`.
+
 
 .. method:: Queue.get_nowait()