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

[Merlijn van Deen (Code Review)]

Merlijn van Deen has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/90728


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(-)


  git pull ssh://gerrit.wikimedia.org:29418/pywikibot/core 
refs/changes/28/90728/1

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):

-- 
To view, visit https://gerrit.wikimedia.org/r/90728
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I8e0f72a35d6923c54d45d31b179f105704af9a4b
Gerrit-PatchSet: 1
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: Merlijn van Deen <valhall...@arctus.nl>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits