Timeout convention could do with documenting

[kinnison]

Many functions take a timeout; but only a few have the format of the timeout documented.

It'd be nice if this were covered in the conventions (then those few functions which mention seconds can be also be cleaned up)

Super-nice would be if every timeout argument in a function description were a link to that convention, though I appreciate that might be harder to do.

[daurnimator]

To clarify: yes, all timeout arguments take seconds.

[daurnimator]

Would this be enough?:

Timeouts

All operations that may block the current thread take a timeout argument.
This argument is always the number of seconds to allow before returning nil, err_msg, ETIMEDOUT where err_msg is a localised error message such as "connection timed out"

[kinnison]

Short, and sweet. Yes, looks good

…

On 26 October 2017 07:36:14 BST, daurnimator ***@***.***> wrote: ``` ## Timeouts All operations that may block the current thread take a `timeout` argument. This argument is always the number of seconds to allow before returning with errno set to `ETIMEDOUT`. ``` Would that be enough? -- You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub: #76 (comment)

-- Sent from my Android device with K-9 Mail. Please excuse my brevity.