Tarantool development patches archive
 help / color / mirror / Atom feed
* [Tarantool-patches] [PATCH] lib: fix comment in coio_task.h
@ 2019-12-03 21:59 Olga Arkhangelskaia
  0 siblings, 0 replies; only message in thread
From: Olga Arkhangelskaia @ 2019-12-03 21:59 UTC (permalink / raw)
  To: tarantool-patches

According to code coio_call does not take a timeout as an argument,
however it was mentioned in the comment and usage example. This lead to
error in documentation. The patch fixes it.

Closes #4663
---
 src/lib/core/coio_task.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/src/lib/core/coio_task.h b/src/lib/core/coio_task.h
index e81e10cca..29b144dea 100644
--- a/src/lib/core/coio_task.h
+++ b/src/lib/core/coio_task.h
@@ -131,8 +131,7 @@ coio_task_post(struct coio_task *task);
 
 /**
  * Create new eio task with specified function and
- * arguments. Yield and wait until the task is complete
- * or a timeout occurs.
+ * arguments. Yield and wait until the task is complete.
  *
  * This function doesn't throw exceptions to avoid double error
  * checking: in most cases it's also necessary to check the return
@@ -150,7 +149,7 @@ coio_task_post(struct coio_task *task);
  *	         return open(filename, flags);
  *	}
  *
- *	if (coio_call(openfile_cb, 0.10, "/tmp/file", 0) == -1)
+ *	if (coio_call(openfile_cb, "/tmp/file", 0) == -1)
  *		// handle errors.
  *	...
  * @endcode
-- 
2.20.1 (Apple Git-117)

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2019-12-03 21:59 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-03 21:59 [Tarantool-patches] [PATCH] lib: fix comment in coio_task.h Olga Arkhangelskaia

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox