jenkins-bot has submitted this change and it was merged.

Change subject: [doc] Add some documentation to PrefixingPageGenerator ......................................................................

[doc] Add some documentation to PrefixingPageGenerator

Change-Id: If79dbef6a0877344ec22aa980c932eee9df9d27d --- M pywikibot/pagegenerators.py 1 file changed, 14 insertions(+), 2 deletions(-)

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

diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index e4bc8da..e0fb239 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -981,11 +981,23 @@ """ Prefixed Page generator.

+ @param prefix: The prefix of the pages. + @type prefix: str + @param namespace: Namespace to retrieve pages from + @type namespace: Namespace or int + @param includeredirects: If includeredirects is None, False or an empty + string, redirects will not be found. If includeredirects equals the + string 'only', only redirects will be found. Otherwise redirects will + be included. + @type includeredirects: None, bool, str + @param site: Site for generator results. + @type site: L{pywikibot.site.BaseSite} @param total: Maximum number of pages to retrieve in total @type total: int @param content: If True, load current version of each page (default False) - @param site: Site for generator results. - @type site: L{pywikibot.site.BaseSite} + @type content: bool + @return: a generator that yields Page objects + @rtype: generator """ if site is None: site = pywikibot.Site()