Tarantool development patches archive
 help / color / mirror / Atom feed
From: Olga Arkhangelskaia <arkholga@tarantool.org>
To: tarantool-patches@dev.tarantool.org
Subject: [Tarantool-patches] [PATCH] lib: fix comment in coio_task.h
Date: Wed,  4 Dec 2019 00:59:11 +0300	[thread overview]
Message-ID: <20191203215911.77284-1-arkholga@tarantool.org> (raw)

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)

                 reply	other threads:[~2019-12-03 21:59 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191203215911.77284-1-arkholga@tarantool.org \
    --to=arkholga@tarantool.org \
    --cc=tarantool-patches@dev.tarantool.org \
    --subject='Re: [Tarantool-patches] [PATCH] lib: fix comment in coio_task.h' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

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