Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805375 )
Change subject: [doc] Update pagegenerators documentation ...................................................................... [doc] Update pagegenerators documentation Remove porting hint. pagegenerators is not just for backwards-compatibility. Also update hint for listpages.py. Change-Id: Ie3544c06e5e2624a68a8173b843d5e35b6a3120f --- M pywikibot/pagegenerators.py 1 file changed, 3 insertions(+), 6 deletions(-) Approvals: DannyS712: Looks good to me, but someone else must approve Xqt: Verified; Looks good to me, approved diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index 390fd2e..3450499 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -4,8 +4,9 @@ A page generator is an object that is iterable (see :pep:`255`) and that yields page objects on which other scripts can then work. -Pagegenerators.py cannot be run as script. For testing purposes listpages.py -can be used instead, to print page titles to standard output. +Most of these functions just wrap a Site or Page method that returns a +generator. For testing purposes listpages.py can be used, to print page +titles to standard output. These parameters are supported to specify which pages titles to print: @@ -67,10 +68,6 @@ ) -# ported from version 1 for backwards-compatibility -# most of these functions just wrap a Site or Page method that returns -# a generator - parameterHelp = """\ GENERATOR OPTIONS ================= -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805375 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Ie3544c06e5e2624a68a8173b843d5e35b6a3120f Gerrit-Change-Number: 805375 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <[email protected]> Gerrit-Reviewer: DannyS712 <[email protected]> Gerrit-Reviewer: Multichill <[email protected]> Gerrit-Reviewer: Russell Blau <[email protected]> Gerrit-Reviewer: Xqt <[email protected]> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged
_______________________________________________ Pywikibot-commits mailing list -- [email protected] To unsubscribe send an email to [email protected]
