jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/371704 )
Change subject: [doc] max_retries and retry_wait defaults is set in config2.py
......................................................................
[doc] max_retries and retry_wait defaults is set in config2.py
- defaults for max_retries and retry_wait are set in config file
(and config.max_retries is now 15 btw.)
- fix spelling mistake in doc string
- keep lines beneath 80 chars
Change-Id: I72b291b69bebd009aa5a822b06496461c3479ee8
---
M pywikibot/data/api.py
1 file changed, 19 insertions(+), 18 deletions(-)
Approvals:
Lokal Profil: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py
index f905bc6..3abfb7f 100644
--- a/pywikibot/data/api.py
+++ b/pywikibot/data/api.py
@@ -1339,16 +1339,16 @@
"""
Create a new Request instance with the given parameters.
- The parameters for the request can be defined via eiter the 'parameters'
- parameter or the keyword arguments. The keyword arguments were the
- previous implementation but could cause problems when there are
- arguments to the API named the same as normal arguments to this class.
- So the second parameter 'parameters' was added which just contains all
- parameters. When a Request instance is created it must use either one
- of them and not both at the same time. To have backwards compatibility
- it adds a parameter named 'parameters' to kwargs when both parameters
- are set as that indicates an old call and 'parameters' was originally
- supplied as a keyword parameter.
+ The parameters for the request can be defined via either the
+ 'parameters' parameter or the keyword arguments. The keyword arguments
+ were the previous implementation but could cause problems when there
+ are arguments to the API named the same as normal arguments to this
+ class. So the second parameter 'parameters' was added which just
+ contains all parameters. When a Request instance is created it must use
+ either one of them and not both at the same time. To have backwards
+ compatibility it adds a parameter named 'parameters' to kwargs when
+ both parameters are set as that indicates an old call and 'parameters'
+ was originally supplied as a keyword parameter.
If undefined keyword arguments were given AND the 'parameters'
parameter was supplied as a positional parameter it still assumes
@@ -1365,17 +1365,18 @@
@param site: The Site to which the request will be submitted. If not
supplied, uses the user's configured default Site.
@param mime: If true, send in "multipart/form-data" format (default
- False). Parameters which should only be transferred via mime mode
- can be defined via that parameter too (an empty dict acts like
- 'True' not like 'False'!).
+ False). Parameters which should only be transferred via mime
+ mode can be defined via that parameter too (an empty dict acts
+ like 'True' not like 'False'!).
@type mime: bool or dict
@param mime_params: DEPRECATED! A dictionary of parameter which should
- only be transferred via mime mode. If not None sets mime to True.
+ only be transferred via mime mode. If not None sets mime to
+ True.
@param max_retries: (optional) Maximum number of times to retry after
- errors, defaults to 25
- @param retry_wait: (optional) Minimum time to wait after an error,
- defaults to 5 seconds (doubles each retry until max of 120 is
- reached)
+ errors, defaults to config.max_retries.
+ @param retry_wait: (optional) Minimum time in seconds to wait after an
+ error, defaults to config.retry_wait seconds (doubles each retry
+ until max of 120 seconds is reached).
@param use_get: (optional) Use HTTP GET request if possible. If False
it uses a POST request. If None, it'll try to determine via
action=paraminfo if the action requires a POST.
--
To view, visit
https://gerrit.wikimedia.org/r/371704
To unsubscribe, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I72b291b69bebd009aa5a822b06496461c3479ee8
Gerrit-PatchSet: 1
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com>
Gerrit-Reviewer: Lokal Profil <lokal.profil(a)gmail.com>
Gerrit-Reviewer: jenkins-bot <>