thiell/test — Issue #219: Timeout is badly explained in API
Author: thiell
Created: 2012-03-03 16:36:52+00:00
State: open
Labels: Doc

How to set a timeout on a command in pydoc is not well explained.

User often try to use {{{resume(timeout=...)}}} instead of {{{task.shell(..., timeout=...)}}}

The timeout option must be better explained for shell() and run().
the timeout option in resume should have a warning and tell to look for timeout option in shell().

Maybe a more general explanation should be put at the beginning of the class? More examples at the beginning ?