jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/498095 )

Change subject: [IMPR] Add corresponding API page links to APISite method docstrings ......................................................................

[IMPR] Add corresponding API page links to APISite method docstrings

Modify the docstring of APISite methods in login .py.

Bug: T100521 Change-Id: I0a7de965f3ee446791067520251f784c2d5f79b6 --- M pywikibot/login.py 1 file changed, 12 insertions(+), 0 deletions(-)

Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified

diff --git a/pywikibot/login.py b/pywikibot/login.py index f4c37c6..3c6e5bb 100644 --- a/pywikibot/login.py +++ b/pywikibot/login.py @@ -127,6 +127,8 @@ """ Check that the username exists on the site.

+ @see: U{https://www.mediawiki.org/wiki/API:Users%7D + @raises NoUsername: Username doesn't exist in user list. """ # convert any Special:BotPassword usernames to main account equivalent @@ -185,6 +187,8 @@ """ Login to the site.

+ @see: U{https://www.mediawiki.org/wiki/API:Login%7D + @return: cookie data if successful, None otherwise. """ # THIS IS OVERRIDDEN IN data/api.py @@ -287,6 +291,8 @@ """ Attempt to log into the server.

+ @see: U{https://www.mediawiki.org/wiki/API:Login%7D + @param retry: infinitely retry if the API returns an unknown error @type retry: bool

@@ -415,6 +421,8 @@ """ Attempt to log into the server.

+ @see: U{https://www.mediawiki.org/wiki/API:Login%7D + @param retry: infinitely retry if exception occurs during authentication. @type retry: bool @@ -454,6 +462,8 @@ """ Return OAuth consumer key token and secret token.

+ @see: U{https://www.mediawiki.org/wiki/API:Tokens%7D + @rtype: tuple of two str """ return self._consumer_token @@ -463,6 +473,8 @@ """ Return OAuth access key token and secret token.

+ @see: U{https://www.mediawiki.org/wiki/API:Tokens%7D + @rtype: tuple of two str """ return self._access_token