summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMattwmaster58 <mattmarcus58@gmail.com>2018-09-09 17:42:39 -0600
committerSeth M. Larson <sethmichaellarson@gmail.com>2018-09-09 18:42:39 -0500
commit1821e73e978e1c550642d98df49da6a77483e80a (patch)
treec2617678036b398db92a5bf3f8cb152b705c0e5f
parenta36d7ea42841f92c4f0811aaa8c8ef9a8c5cfbcd (diff)
downloadurllib3-1821e73e978e1c550642d98df49da6a77483e80a.tar.gz
Change ambiguous description of backoff_factor (#1436)
Change from `^` to `**`. Programmers not familiar with python might assume the ^ is the exponent operator, when in fact it is the bitwise XOR operator. This change will remove the ambiguity.
-rw-r--r--src/urllib3/util/retry.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/urllib3/util/retry.py b/src/urllib3/util/retry.py
index 7ad3dc66..e7d0abd6 100644
--- a/src/urllib3/util/retry.py
+++ b/src/urllib3/util/retry.py
@@ -115,7 +115,7 @@ class Retry(object):
(most errors are resolved immediately by a second try without a
delay). urllib3 will sleep for::
- {backoff factor} * (2 ^ ({number of total retries} - 1))
+ {backoff factor} * (2 ** ({number of total retries} - 1))
seconds. If the backoff_factor is 0.1, then :func:`.sleep` will sleep
for [0.0s, 0.2s, 0.4s, ...] between retries. It will never be longer