summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2018-09-28 22:05:45 +0300
committerDamien George <damien.p.george@gmail.com>2018-10-05 16:57:58 +1000
commitd251f2668874f454a2447eebbec2379a384ad2c9 (patch)
treebeb7fb771b723430c55e3486d83302ee391c2eff /docs/library
parent6ef783527d5f73508efdd956730162127212def2 (diff)
docs/uselect: Describe more aspects of poll.register/modify behavior.
E.g., register() can be called again for the same object, while modify() will raise exception if object was not register()ed before.
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/uselect.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/library/uselect.rst b/docs/library/uselect.rst
index 77d458473..e1becc60e 100644
--- a/docs/library/uselect.rst
+++ b/docs/library/uselect.rst
@@ -45,13 +45,18 @@ Methods
*eventmask* defaults to ``uselect.POLLIN | uselect.POLLOUT``.
+ It is OK to call this function multiple times for the same *obj*.
+ Successive calls will update *obj*'s eventmask to the value of
+ *eventmask* (i.e. will behave as `modify()`).
+
.. method:: poll.unregister(obj)
Unregister *obj* from polling.
.. method:: poll.modify(obj, eventmask)
- Modify the *eventmask* for *obj*.
+ Modify the *eventmask* for *obj*. If *obj* is not registered, `OSError`
+ is raised with error of ENOENT.
.. method:: poll.poll(timeout=-1)