diff options
| author | Jason Neal <jason.neal@astro.up.pt> | 2020-01-11 19:44:17 +1300 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2020-01-12 13:44:59 +1100 |
| commit | 7ef2f65114f092be6303c145a2560fdf522dcde0 (patch) | |
| tree | 52ea36a8dc03bc5e6a4b0b4b332a5c8d784d8a39 /docs/library/uselect.rst | |
| parent | 6632dd3981cbdca8e70c0bf19e36338101e9ce0e (diff) | |
docs/library: Add / to indicate positional-only args in library docs.
Removes the confusion of positional-only arguments which have defaults that
look like keyword arguments.
Diffstat (limited to 'docs/library/uselect.rst')
| -rw-r--r-- | docs/library/uselect.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/uselect.rst b/docs/library/uselect.rst index e1becc60e..0c3bdfdfd 100644 --- a/docs/library/uselect.rst +++ b/docs/library/uselect.rst @@ -58,7 +58,7 @@ Methods Modify the *eventmask* for *obj*. If *obj* is not registered, `OSError` is raised with error of ENOENT. -.. method:: poll.poll(timeout=-1) +.. method:: poll.poll(timeout=-1, /) Wait for at least one of the registered objects to become ready or have an exceptional condition, with optional timeout in milliseconds (if *timeout* @@ -81,7 +81,7 @@ Methods Tuples returned may contain more than 2 elements as described above. -.. method:: poll.ipoll(timeout=-1, flags=0) +.. method:: poll.ipoll(timeout=-1, flags=0, /) Like :meth:`poll.poll`, but instead returns an iterator which yields a `callee-owned tuple`. This function provides an efficient, allocation-free |