tim-kos/node-retry

Docs: clarify whether `retries: 1` means 'do it once' or 'do it twice'

craigds opened this issue · 1 comments

Naïve reading of the docs would suggest retries: 1 means 'do it once, and then retry it once if it failed'.

Is that what it means? Or is it 'do it once and then stop'?

Naïve reading of the docs would suggest retries: 1 means 'do it once, and then retry it once if it failed'.

That's what it do, from my experience. I think it's correct and inferable from the name itself (retries), however I agree that it can be said explicitly in docs.