Add some extra wording and comments in the "Assert" section of the documentation.
Why
It is not immediately clear from the code itself or the documentation if timeout is referring to each attempt or to the entire round of attempting (it's the entire round of attempting)
At least one attempt should be specified in order to get the implied retry functionality
When both timeout and attempts are used together whichever limit is hit first will cause the process to either fail or run the optional command.
@pblesi - is this all accurate? It has been my experience in using some of this code, but I may well be misunderstanding something :smile:
What
Add some extra wording and comments in the "Assert" section of the documentation.
Why
timeoutis referring to each attempt or to the entire round of attempting (it's the entire round of attempting)attemptshould be specified in order to get the implied retry functionalitytimeoutandattemptsare used together whichever limit is hit first will cause the process to either fail or run the optional command.@pblesi - is this all accurate? It has been my experience in using some of this code, but I may well be misunderstanding something :smile: