jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/435646 )
Change subject: [doc] Update Site.loadrevisions doc string ......................................................................
[doc] Update Site.loadrevisions doc string
Bug: T195650 Change-Id: I86ed54fbf5f45a926b92af42ba9c5bba27e18aee --- M pywikibot/site.py 1 file changed, 6 insertions(+), 4 deletions(-)
Approvals: Framawiki: Looks good to me, approved jenkins-bot: Verified
diff --git a/pywikibot/site.py b/pywikibot/site.py index 6e847c4..fe86d69 100644 --- a/pywikibot/site.py +++ b/pywikibot/site.py @@ -3981,7 +3981,7 @@ endtime=None, rvdir=None, user=None, excludeuser=None, section=None, sysop=False, step=None, total=None, rollback=False): - """Retrieve and store revision information. + """Retrieve revision information and store it in page object.
By default, retrieves the last (current) revision of the page, unless any of the optional parameters revids, startid, endid, @@ -3993,8 +3993,8 @@ endid if both are specified; likewise, starttime must be greater than endtime. If rvdir is True, these relationships are reversed.
- @param page: retrieve revisions of this Page (required unless ids - is specified) + @param page: retrieve revisions of this Page and hold the data. + @type page: pywikibot.Page @param content: if True, retrieve the wiki-text of each revision; otherwise, only retrieve the revision metadata (default) @type content: bool @@ -4003,7 +4003,7 @@ the article is section 0), not name @type section: int @param revids: retrieve only the specified revision ids (raise - Exception if any of revids does not correspond to page + Exception if any of revids does not correspond to page) @type revids: an int, a str or a list of ints or strings @param startid: retrieve revisions starting with this revid @param endid: stop upon retrieving this revid @@ -4015,6 +4015,8 @@ @param excludeuser: retrieve all revisions not authored by this user @param sysop: if True, switch to sysop account (if available) to retrieve this page + @raises ValueError: invalid startid/endid or starttime/endtime values + @raises pywikibot.Error: revids belonging to a different page """ latest = (revids is None and startid is None and