jenkins-bot has submitted this change and it was merged.
Change subject: Added links to Mediawiki API docs in some APISite methods
......................................................................
Added links to Mediawiki API docs in some APISite methods
Change-Id: Ice6342f49b7ccde14e1d0e83af0f69ef1014c8f3
---
M pywikibot/site.py
1 file changed, 13 insertions(+), 2 deletions(-)
Approvals:
John Vandenberg: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/site.py b/pywikibot/site.py
index 0bbf596..7e0fae9 100644
--- a/pywikibot/site.py
+++ b/pywikibot/site.py
@@ -2000,7 +2000,11 @@
return auth_token is not None and len(auth_token) == 4
def login(self, sysop=False):
- """Log the user in if not already logged in."""
+ """
+ Log the user in if not already logged in.
+
+ U{https://www.mediawiki.org/wiki/API:Login}
+ """
# TODO: this should include an assert that loginstatus
# is not already IN_PROGRESS, however the
# login status may be left 'IN_PROGRESS' because
@@ -2069,9 +2073,11 @@
self.login(old_status)
def logout(self):
- """Logout of the site and load details for the logged out user.
+ """
+ Logout of the site and load details for the logged out user.
Also logs out of the global account if linked to the user.
+ U{https://www.mediawiki.org/wiki/API:Logout}
@raises APIError: Logout is not available when OAuth enabled.
"""
@@ -2094,6 +2100,8 @@
- rights: list of rights (could be empty)
- message: present if user has a new message on talk page
- blockinfo: present if user is blocked (dict)
+
+ U{https://www.mediawiki.org/wiki/API:Userinfo}
@param force: force to retrieve userinfo ignoring cache
@type force: bool
@@ -2151,6 +2159,7 @@
To check whether a user can perform an action,
the method has_right should be used.
+ U{https://www.mediawiki.org/wiki/API:Userinfo}
@param sysop: If true, log in to sysop account (if available)
@type sysop: bool
@@ -2234,6 +2243,7 @@
* Actions: edit, move, delete, protect, upload
* User levels: autoconfirmed, sysop, bot
+ U{https://www.mediawiki.org/wiki/API:Userinfo}
"""
if not self.logged_in(sysop):
self.login(sysop)
@@ -2244,6 +2254,7 @@
Possible values of 'group' may vary depending on wiki settings,
but will usually include bot.
+ U{https://www.mediawiki.org/wiki/API:Userinfo}
"""
if not self.logged_in(sysop):
--
To view, visit https://gerrit.wikimedia.org/r/260873
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ice6342f49b7ccde14e1d0e83af0f69ef1014c8f3
Gerrit-PatchSet: 4
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: Yujwey <rawzau...@gmail.com>
Gerrit-Reviewer: John Vandenberg <jay...@gmail.com>
Gerrit-Reviewer: Ladsgroup <ladsgr...@gmail.com>
Gerrit-Reviewer: Xqt <i...@gno.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
