jenkins-bot merged this change.
[doc] Update breaking change info for getVersionHistory
Change-Id: I20f563b45ec8864569c4f3f788c6ddbc4ea0d81a
---
M pywikibot/page/__init__.py
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py
index f2f6db8..a1a92b5 100644
--- a/pywikibot/page/__init__.py
+++ b/pywikibot/page/__init__.py
@@ -1758,9 +1758,16 @@
return (self._revisions[rev] for rev in
sorted(self._revisions, reverse=not reverse)[:total])
- # BREAKING CHANGE: in old framework, default value for getVersionHistory
- # returned no more than 500 revisions; now, it iterates
- # all revisions unless 'total' argument is used
+ # BREAKING CHANGES:
+ #
+ # in old framework, default value for getVersionHistory returned no more
+ # than 500 revisions; now, it returns a list of all revisions unless
+ # 'total' argument is used.
+ #
+ # in new framework each list entry is a tuple of 4 items:
+ # (revid, timestamp, user, comment)
+ # whereas old framework had a tuple of 6 items:
+ # (revid, timestamp, user, comment, size, tags)
@deprecated('Page.revisions()', since='20150206')
@deprecated_args(forceReload=None, revCount='total', step=None,
getAll=None, reverseOrder='reverse')
To view, visit change 584191. To unsubscribe, or for help writing mail filters, visit settings.