18797: Update style of arvados.retry docstrings. 18797-retry-docstrings
authorBrett Smith <brett.smith@curii.com>
Thu, 10 Nov 2022 21:58:21 +0000 (16:58 -0500)
committerBrett Smith <brett.smith@curii.com>
Mon, 21 Nov 2022 15:32:11 +0000 (10:32 -0500)
commitbb406742b50b90d3796ec86c4c7f806004cc3933
tree34c93ec060c512a1453100d955124a9127adbcc3
parentd760c01e23eb731235aee6e47c5a4b0aeed1d275
18797: Update style of arvados.retry docstrings.

I wrote these docstrings as a demonstration of new style rules for our
Python SDK. It is real, useful documentation, as well as a good
illustration of how to follow the new style guide, so we might as well
merge it.

This is primarily a style update to the existing docstrings. In places
where I've actually changed the meaning, I believe the new meaning is
more correct. In particular, RetryLoop's "attempts" count the number of
saved results, which may or may not be the same as the number of times
the loop has run depending on what the body does.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>
sdk/python/arvados/retry.py