summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-06-16 19:49:54 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-06-16 19:49:54 +0200
commita402d08da41413507a4ebebf18de897f7ddf1dd2 (patch)
tree57535f212c33fff6d2d7abf4c48347dc858a3f39
parent42ec43022e3ff82873d7d36e5f895380f4a12129 (diff)
downloadpython-systemd-a402d08da41413507a4ebebf18de897f7ddf1dd2.tar.gz
docs: mention .process() in docstring of .fileno()
Together with the previous commit, this makes it much easier to find the right docs. Fixes #48.
-rw-r--r--systemd/_reader.c7
1 files changed, 5 insertions, 2 deletions
diff --git a/systemd/_reader.c b/systemd/_reader.c
index 3b65200..c9aa11d 100644
--- a/systemd/_reader.c
+++ b/systemd/_reader.c
@@ -327,7 +327,10 @@ PyDoc_STRVAR(Reader_fileno__doc__,
"fileno() -> int\n\n"
"Get a file descriptor to poll for changes in the journal.\n"
"This method invokes sd_journal_get_fd().\n"
- "See :manpage:`sd_journal_get_fd(3)`.");
+ "See :manpage:`sd_journal_get_fd(3)`.\n\n"
+ "When the file descriptor returned by this function is used a poll\n"
+ "loop, .process() should be used to process events and reset the readability\n"
+ "state of the file descriptor.");
static PyObject* Reader_fileno(Reader *self, PyObject *args) {
int fd;
@@ -850,7 +853,7 @@ static PyObject* Reader_seek_monotonic(Reader *self, PyObject *args) {
PyDoc_STRVAR(Reader_process__doc__,
"process() -> state change (integer)\n\n"
- "Process events and reset the readable state of the file\n"
+ "Process events and reset the readability state of the file\n"
"descriptor returned by .fileno().\n\n"
"Will return constants: NOP if no change; APPEND if new\n"
"entries have been added to the end of the journal; and\n"