jenkins-bot has submitted this change and it was merged.
Change subject: Improve epydoc formatting
......................................................................
Improve epydoc formatting
Change-Id: I888e606054a0afec65f9ada8f997e7bb18376b0e
---
M scripts/maintenance/make_i18n_dict.py
1 file changed, 9 insertions(+), 4 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/scripts/maintenance/make_i18n_dict.py
b/scripts/maintenance/make_i18n_dict.py
index 2283bdf..81d80ea 100755
--- a/scripts/maintenance/make_i18n_dict.py
+++ b/scripts/maintenance/make_i18n_dict.py
@@ -5,29 +5,34 @@
usage:
-run IDLE at topmost level
+run IDLE at topmost level:
+
>>> import pwb
>>> from scripts.maintenance.make_i18n_dict import i18nBot
>>> bot = i18nBot('<scriptname>', '<msg dict>')
>>> bot.run()
If you have more than one message dictionary, give all these names to the bot:
+
>>> bot = i18nBot('<scriptname>', '<msg dict1>', '<msg dict2>', '<msg dict3>')
If you want to rename the message index use keyword arguments. This may be
mixed with preleading positonal argumens:
+
>>> bot = i18nBot('<scriptname>', '<msg dict1>', the_other_msg='<msg dict2>')
If you have the messages as instance constants you may call the bot as follows:
+
>>> bot = i18nBot('<scriptname>.<class instance>', '<msg dict1>', '<msg
>>> dict2>')
It's also possible to make json files too by using to_json method after
-instantiating the bot. It also calls bot.run() to create the dictionaries.
+instantiating the bot. It also calls C{bot.run()} to create the dictionaries:
+
>>> bot.to_json()
"""
#
-# (C) xqt, 2013-2015
-# (C) Pywikibot team, 2013-2015
+# (C) xqt, 2013-2016
+# (C) Pywikibot team, 2013-2016
#
# Distributed under the terms of the MIT license.
#
--
To view, visit https://gerrit.wikimedia.org/r/270477
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I888e606054a0afec65f9ada8f997e7bb18376b0e
Gerrit-PatchSet: 1
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: Xqt <i...@gno.de>
Gerrit-Reviewer: John Vandenberg <jay...@gmail.com>
Gerrit-Reviewer: Xqt <i...@gno.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
Pywikibot-commits mailing list
Pywikibot-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/pywikibot-commits
