[Pywikibot-commits] [Gerrit] Show page generators parameters in module documentation - change (pywikibot/core)

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

Change subject: Show page generators parameters in module documentation ......................................................................

Show page generators parameters in module documentation

Change-Id: I8e0f72a35d6923c54d45d31b179f105704af9a4b --- M pywikibot/pagegenerators.py 1 file changed, 5 insertions(+), 0 deletions(-)

Approvals: Xqt: Looks good to me, approved Mineo: Looks good to me, but someone else must approve jenkins-bot: Verified

diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index d749dbc..fbc27c2 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -169,6 +169,11 @@ # if a bot uses GeneratorFactory, the module should include the line # docuReplacements = {'&params;': pywikibot.pagegenerators.parameterHelp} # and include the marker &params; in the module's docstring +# +# We manually include it so the parameters show up in the auto-generated +# module documentation: + +__doc__ = __doc__.replace("&params;", parameterHelp)

class GeneratorFactory(object):