Jason Neal
|
7ef2f65114
|
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.
|
5 years ago |
Paul Sokolovsky
|
d251f26688
|
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.
|
6 years ago |
Damien George
|
0db49c37a4
|
docs: Fix some references and RST markup to eliminate Sphinx warnings.
|
7 years ago |
|
Paul Sokolovsky
|
3ff7040c8a
|
docs/library: Add xrefs to "stream" dictionary entry for many modules.
|
7 years ago |
|
Paul Sokolovsky
|
4fee35a32c
|
docs/glossary: Describe the callee-owned tuple concept.
|
7 years ago |
|
Paul Sokolovsky
|
cb9da2279b
|
docs/uselect: ipoll: Fix grammar/wording of one-shot flag description.
|
7 years ago |
|
Paul Sokolovsky
|
f59c6b48ae
|
docs/uselect: Describe POLLHUP/POLLERR semantics in more details.
Per POSIX, http://pubs.opengroup.org/onlinepubs/9699919799/functions/poll.html
these flags aren't valid in the input eventmask. Instead, they can be
returned in unsolicited manner in the output eventmask at any time.
|
7 years ago |
|
Paul Sokolovsky
|
067bf849d2
|
docs/uselect: poll: Explicitly specify that no-timeout value is -1.
|
7 years ago |
|
Paul Sokolovsky
|
328c1e78be
|
docs/uselect: Document one-shot polling mode.
|
7 years ago |
|
Paul Sokolovsky
|
465d84b7e7
|
docs/library: Add CPython docs xref to each pertinent module.
Cross-reference text/link is implemented as RST substitution, so easy to
consistently.
|
7 years ago |
|
Paul Sokolovsky
|
871a45dd0c
|
docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.
|
7 years ago |
|
Paul Sokolovsky
|
94696973a0
|
docs/select: Rename to uselect, to match the actual module name.
Also, add ipoll() documentation and markup changes to comply with CPython
usage.
|
8 years ago |
|
Paul Sokolovsky
|
617e033e2f
|
docs/select: Add an article.
|
9 years ago |
|
Paul Sokolovsky
|
549c79d11e
|
docs/select: Document POLLIN/OUT/ERR/HUP.
|
9 years ago |
|
Paul Sokolovsky
|
98b6d35c4f
|
docs: select: Describe poll.poll() return value in detail.
|
9 years ago |
|
Paul Sokolovsky
|
d8474d3617
|
docs: select: Describe extra details.
|
10 years ago |
|
Damien George
|
a58713a899
|
docs: Cleanup and update some docs.
|
10 years ago |
|
Damien George
|
88d3054ac0
|
docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
|
10 years ago |
