jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1064016?usp=email )
Change subject: [doc] update documentation
......................................................................
[doc] update documentation
Change-Id: I2d686feebaa5432c7ee3b5ff7385ad94ca461179
---
M docs/introduction.rst
M docs/mwapi.rst
M pywikibot/scripts/__init__.py
M pywikibot/scripts/preload_sites.py
M pywikibot/scripts/shell.py
5 files changed, 53 insertions(+), 40 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/docs/introduction.rst b/docs/introduction.rst
index a10f78e..70bf537 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -41,4 +41,4 @@
* :manpage:`i18n` Manual
* `MediaWiki Language Codes
<https://www.mediawiki.org/wiki/Manual:Language#Language_code>`_
* :ref:`User Interface Settings`
- * :py:mod:`pywikibot.i18n`
+ * :mod:`i18n`
diff --git a/docs/mwapi.rst b/docs/mwapi.rst
index 887b0ba7..8852829 100644
--- a/docs/mwapi.rst
+++ b/docs/mwapi.rst
@@ -62,41 +62,9 @@
- :meth:`BasePage.expand_text()<page.BasePage.expand_text>`
- :meth:`textlib.getCategoryLinks`
* - :api:`flow<flow>`
- - :meth:`load_board()<pywikibot.site._extensions.FlowMixin.load_board>`
-
:meth:`load_topiclist()<pywikibot.site._extensions.FlowMixin.load_topiclist>`
- :meth:`load_topic()<pywikibot.site._extensions.FlowMixin.load_topic>`
-
:meth:`load_post_current_revision()<pywikibot.site._extensions.FlowMixin.load_post_current_revision>`
-
:meth:`create_new_topic()<pywikibot.site._extensions.FlowMixin.create_new_topic>`
-
:meth:`reply_to_post()<pywikibot.site._extensions.FlowMixin.reply_to_post>` |br|
- :meth:`lock_topic()<pywikibot.site._extensions.FlowMixin.lock_topic>`
-
:meth:`moderate_topic()<pywikibot.site._extensions.FlowMixin.moderate_topic>`
-
:meth:`delete_topic()<pywikibot.site._extensions.FlowMixin.delete_topic>` |br|
- :meth:`hide_topic()<pywikibot.site._extensions.FlowMixin.hide_topic>`
-
:meth:`suppress_topic()<pywikibot.site._extensions.FlowMixin.suppress_topic>`
-
:meth:`restore_topic()<pywikibot.site._extensions.FlowMixin.restore_topic>`
-
:meth:`moderate_post()<pywikibot.site._extensions.FlowMixin.moderate_post>`
- :meth:`delete_post()<pywikibot.site._extensions.FlowMixin.delete_post>`
|br|
- :meth:`hide_post()<pywikibot.site._extensions.FlowMixin.hide_post>` |br|
-
:meth:`suppress_post()<pywikibot.site._extensions.FlowMixin.suppress_post>`
-
:meth:`restore_post()<pywikibot.site._extensions.FlowMixin.restore_post>`
+ - *deprecated, see below*
-
- - :meth:`flow.Board.topics`
- :meth:`flow.Topic.create_topic`
- :meth:`flow.Topic.lock`
- :meth:`flow.Topic.unlock`
- :meth:`flow.Topic.delete_mod`
- :meth:`flow.Topic.hide`
- :meth:`flow.Topic.suppress`
- :meth:`flow.Topic.retore`
- :meth:`flow.Post.reply`
- :meth:`flow.Post.delete`
- :meth:`flow.Post.hide`
- :meth:`flow.Post.suppress`
- :meth:`flow.Post.restore`
- * - :api:`flowthank<flowthank>`
- -
:meth:`thank_post()<pywikibot.site._extensions.ThanksFlowMixin.thank_post>`
-
- - :meth:`flow.Post.thank`
* - :api:`login<login>`
- :meth:`login()<pywikibot.site._apisite.APISite.login>`
-
@@ -170,3 +138,51 @@
- :meth:`watch()<pywikibot.site._apisite.APISite.watch>`
- :meth:`BasePage.watch()<page.BasePage.watch>`
-
+
+Flow support
+============
+
+.. deprecated:: 9.4
+ will be removed with Pywikibot 12 or earlier (:phab:`T371180`).
+
+.. list-table::
+ :header-rows: 1
+ :align: left
+
+ * - action
+ - APISite method
+ - flow module method
+ * - :api:`flow<flow>`
+ - :meth:`load_board()<pywikibot.site._extensions.FlowMixin.load_board>`
|br|
+
:meth:`load_topiclist()<pywikibot.site._extensions.FlowMixin.load_topiclist>`
|br|
+ :meth:`load_topic()<pywikibot.site._extensions.FlowMixin.load_topic>`
|br|
+
:meth:`load_post_current_revision()<pywikibot.site._extensions.FlowMixin.load_post_current_revision>`
|br|
+
:meth:`create_new_topic()<pywikibot.site._extensions.FlowMixin.create_new_topic>`
|br|
+
:meth:`reply_to_post()<pywikibot.site._extensions.FlowMixin.reply_to_post>` |br|
+ :meth:`lock_topic()<pywikibot.site._extensions.FlowMixin.lock_topic>`
|br|
+
:meth:`moderate_topic()<pywikibot.site._extensions.FlowMixin.moderate_topic>`
|br|
+
:meth:`delete_topic()<pywikibot.site._extensions.FlowMixin.delete_topic>` |br|
+ :meth:`hide_topic()<pywikibot.site._extensions.FlowMixin.hide_topic>`
|br|
+
:meth:`suppress_topic()<pywikibot.site._extensions.FlowMixin.suppress_topic>`
|br|
+
:meth:`restore_topic()<pywikibot.site._extensions.FlowMixin.restore_topic>` |br|
+
:meth:`moderate_post()<pywikibot.site._extensions.FlowMixin.moderate_post>` |br|
+ :meth:`delete_post()<pywikibot.site._extensions.FlowMixin.delete_post>`
|br|
+ :meth:`hide_post()<pywikibot.site._extensions.FlowMixin.hide_post>` |br|
+
:meth:`suppress_post()<pywikibot.site._extensions.FlowMixin.suppress_post>` |br|
+
:meth:`restore_post()<pywikibot.site._extensions.FlowMixin.restore_post>` |br|
+ - :meth:`flow.Board.topics` |br|
+ :meth:`flow.Topic.create_topic` |br|
+ :meth:`flow.Topic.lock` |br|
+ :meth:`flow.Topic.unlock` |br|
+ :meth:`flow.Topic.delete_mod` |br|
+ :meth:`flow.Topic.hide` |br|
+ :meth:`flow.Topic.suppress` |br|
+ :meth:`flow.Topic.restore` |br|
+ :meth:`flow.Post.reply` |br|
+ :meth:`flow.Post.delete` |br|
+ :meth:`flow.Post.hide` |br|
+ :meth:`flow.Post.suppress` |br|
+ :meth:`flow.Post.restore` |br|
+ * - :api:`flowthank<flowthank>`
+ -
:meth:`thank_post()<pywikibot.site._extensions.ThanksFlowMixin.thank_post>`
+ - :meth:`flow.Post.thank`
diff --git a/pywikibot/scripts/__init__.py b/pywikibot/scripts/__init__.py
index 5428813..fabe48b 100644
--- a/pywikibot/scripts/__init__.py
+++ b/pywikibot/scripts/__init__.py
@@ -1,8 +1,5 @@
"""Folder which holds framework scripts.
-When uploading pywikibot to pypi the pwb.py (wrapper script) and
-pywikibot i18n package are copied here.
-
.. versionadded:: 7.0
"""
#
diff --git a/pywikibot/scripts/preload_sites.py
b/pywikibot/scripts/preload_sites.py
index 27a31f7..6bd3b66 100755
--- a/pywikibot/scripts/preload_sites.py
+++ b/pywikibot/scripts/preload_sites.py
@@ -3,7 +3,7 @@
The following parameters are supported:
--worker:<num> The number of parallel tasks to be run. Default is the
+ -worker:<num> The number of parallel tasks to be run. Default is the
number of processors on the machine
**Usage:**
diff --git a/pywikibot/scripts/shell.py b/pywikibot/scripts/shell.py
index 399c5c4..2751e3a 100755
--- a/pywikibot/scripts/shell.py
+++ b/pywikibot/scripts/shell.py
@@ -4,9 +4,9 @@
To exit the shell, type :kbd:`ctrl-D` (Linux) or :kbd:`ctrl-Z` (Windows)
or use the :func:`exit` function.
-The following local option is supported::
+The following local option is supported:
- -noimport Do not import the pywikibot library. All other arguments are
+-noimport Do not import the pywikibot library. All other arguments are
ignored in this case.
Usage::
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1064016?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings?usp=email
Gerrit-MessageType: merged
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I2d686feebaa5432c7ee3b5ff7385ad94ca461179
Gerrit-Change-Number: 1064016
Gerrit-PatchSet: 1
Gerrit-Owner: Xqt <i...@gno.de>
Gerrit-Reviewer: Xqt <i...@gno.de>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
Pywikibot-commits mailing list -- pywikibot-commits@lists.wikimedia.org
To unsubscribe send an email to pywikibot-commits-le...@lists.wikimedia.org
