Xqt has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/785814 )
Change subject: [doc] Update sphinx doc
......................................................................
[doc] Update sphinx doc
Change-Id: I89f3871b4ad43d9e45b1923425c1ec7562f78ba9
---
M docs/scripts/auxiliary.rst
M docs/scripts/categories.rst
M docs/scripts/general.rst
M docs/scripts/global.rst
M docs/scripts/images.rst
M docs/scripts/main.rst
M docs/scripts/maintenance.rst
M docs/scripts/nonedit.rst
M docs/scripts/other.rst
M docs/scripts/templates.rst
M docs/scripts/unsorted.rst
M docs/scripts/wikibase.rst
M pywikibot/textlib.py
13 files changed, 107 insertions(+), 106 deletions(-)
Approvals:
jenkins-bot: Verified
Xqt: Looks good to me, approved
diff --git a/docs/scripts/auxiliary.rst b/docs/scripts/auxiliary.rst
index 1cbae28..c24054f 100644
--- a/docs/scripts/auxiliary.rst
+++ b/docs/scripts/auxiliary.rst
@@ -1,20 +1,20 @@
Auxiliary scripts
=================
-clean\_sandbox script
----------------------
+clean\_sandbox script description
+---------------------------------
.. automodule:: scripts.clean_sandbox
:no-members:
-cosmetic\_changes script
-------------------------
+cosmetic\_changes script description
+------------------------------------
.. automodule:: scripts.cosmetic_changes
:no-members:
-transferbot script
-------------------
+transferbot script description
+------------------------------
.. automodule:: scripts.transferbot
:no-members:
diff --git a/docs/scripts/categories.rst b/docs/scripts/categories.rst
index 12fa562..5fa1fa0 100644
--- a/docs/scripts/categories.rst
+++ b/docs/scripts/categories.rst
@@ -1,14 +1,14 @@
Categories scripts
==================
-category\_redirect script
--------------------------
+category\_redirect script description
+-------------------------------------
.. automodule:: scripts.category_redirect
:no-members:
-commonscat script
------------------
+commonscat script description
+-----------------------------
.. automodule:: scripts.commonscat
:no-members:
diff --git a/docs/scripts/general.rst b/docs/scripts/general.rst
index 6f4856a..93a801d 100644
--- a/docs/scripts/general.rst
+++ b/docs/scripts/general.rst
@@ -1,20 +1,20 @@
General pages changes scripts
=============================
-archivebot script description
------------------------------
+archivebot script description description
+-----------------------------------------
.. automodule:: scripts.archivebot
:no-members:
-movepages script description
-----------------------------
+movepages script description description
+----------------------------------------
.. automodule:: scripts.movepages
:no-members:
-pagefromfile script description
--------------------------------
+pagefromfile script description description
+-------------------------------------------
.. automodule:: scripts.pagefromfile
:no-members:
diff --git a/docs/scripts/global.rst b/docs/scripts/global.rst
index 4614291..9730140 100644
--- a/docs/scripts/global.rst
+++ b/docs/scripts/global.rst
@@ -1,8 +1,8 @@
Global bot scripts
==================
-interwiki script
-----------------
+interwiki script description
+----------------------------
Creates or modifies Interlanguage links between projects.
@@ -10,8 +10,8 @@
:no-members:
-redirect script
----------------
+redirect script description
+---------------------------
.. automodule:: scripts.redirect
:no-members:
diff --git a/docs/scripts/images.rst b/docs/scripts/images.rst
index 390e42d..d6fe32a 100644
--- a/docs/scripts/images.rst
+++ b/docs/scripts/images.rst
@@ -1,44 +1,44 @@
Images scripts
==============
-checkimages script
-------------------
+checkimages script description
+------------------------------
.. automodule:: scripts.checkimages
:no-members:
-commons\_information script
----------------------------
+commons\_information script description
+---------------------------------------
.. automodule:: scripts.commons_information
:no-members:
-data\_ingestion script
-----------------------
+data\_ingestion script description
+----------------------------------
.. automodule:: scripts.data_ingestion
:no-members:
-image script
-------------
+image script description
+------------------------
.. automodule:: scripts.image
:no-members:
-imagetransfer script
---------------------
+imagetransfer script description
+--------------------------------
.. automodule:: scripts.imagetransfer
:no-members:
-nowcommons script
------------------
+nowcommons script description
+-----------------------------
.. automodule:: scripts.nowcommons
:no-members:
-unusedfiles script
-------------------
+unusedfiles script description
+------------------------------
.. automodule:: scripts.unusedfiles
:no-members:
diff --git a/docs/scripts/main.rst b/docs/scripts/main.rst
index 9e2af44..b3ad628 100644
--- a/docs/scripts/main.rst
+++ b/docs/scripts/main.rst
@@ -1,38 +1,38 @@
Main bot scripts
================
-add\_text script
-----------------
+add\_text script description
+----------------------------
.. automodule:: scripts.add_text
:no-members:
-category script
----------------
+category script description
+---------------------------
.. automodule:: scripts.category
:no-members:
-replace script
---------------
+replace script description
+--------------------------
.. automodule:: scripts.replace
:no-members:
-solve\_disambiguation script
-----------------------------
+solve\_disambiguation script description
+----------------------------------------
.. automodule:: scripts.solve_disambiguation
:no-members:
-upload script
--------------
+upload script description
+-------------------------
.. automodule:: scripts.upload
:no-members:
-weblinkchecker script
----------------------
+weblinkchecker script description
+---------------------------------
.. automodule:: scripts.weblinkchecker
:no-members:
diff --git a/docs/scripts/maintenance.rst b/docs/scripts/maintenance.rst
index 9c38b68..d096563 100644
--- a/docs/scripts/maintenance.rst
+++ b/docs/scripts/maintenance.rst
@@ -1,38 +1,38 @@
Utility scripts
===============
-cache script
-------------
+cache script description
+------------------------
.. automodule:: scripts.maintenance.cache
:no-members:
-colors script
--------------
+colors script description
+-------------------------
.. automodule:: scripts.maintenance.colors
:no-members:
-preload_sites script
---------------------
+preload_sites script description
+--------------------------------
.. automodule:: scripts.maintenance.preload_sites
:no-members:
-sorting\_order script
----------------------
+sorting\_order script description
+---------------------------------
.. automodule:: scripts.maintenance.sorting_order
:no-members:
-update\_linktrails script
--------------------------
+update\_linktrails script description
+-------------------------------------
.. automodule:: scripts.maintenance.update_linktrails
:no-members:
-wikimedia\_sites script
------------------------
+wikimedia\_sites script description
+-----------------------------------
.. automodule:: scripts.maintenance.wikimedia_sites
:no-members:
diff --git a/docs/scripts/nonedit.rst b/docs/scripts/nonedit.rst
index 62e3cfd..851bb6a 100644
--- a/docs/scripts/nonedit.rst
+++ b/docs/scripts/nonedit.rst
@@ -1,14 +1,14 @@
Non editing scripts
===================
-listpages script
-----------------
+listpages script description
+----------------------------
.. automodule:: scripts.listpages
:no-members:
-touch script
-------------
+touch script description
+------------------------
.. automodule:: scripts.touch
:no-members:
diff --git a/docs/scripts/other.rst b/docs/scripts/other.rst
index 620aeda..f462718 100644
--- a/docs/scripts/other.rst
+++ b/docs/scripts/other.rst
@@ -1,8 +1,8 @@
Other bot scripts
=================
-welcome script
---------------
+welcome script description
+--------------------------
.. automodule:: scripts.welcome
:no-members:
diff --git a/docs/scripts/templates.rst b/docs/scripts/templates.rst
index 1625bbf..50d77ba 100644
--- a/docs/scripts/templates.rst
+++ b/docs/scripts/templates.rst
@@ -1,14 +1,14 @@
Template scripts
================
-template script
----------------
+template script description
+---------------------------
.. automodule:: scripts.template
:no-members:
-templatecount script
---------------------
+templatecount script description
+--------------------------------
.. automodule:: scripts.templatecount
:no-members:
diff --git a/docs/scripts/unsorted.rst b/docs/scripts/unsorted.rst
index f7686d2..b3ef927 100644
--- a/docs/scripts/unsorted.rst
+++ b/docs/scripts/unsorted.rst
@@ -1,81 +1,81 @@
Unsorted scripts
================
-basic script
-------------
+basic script description
+------------------------
.. automodule:: scripts.basic
:no-members:
-change\_pagelang script
------------------------
+change\_pagelang script description
+-----------------------------------
.. automodule:: scripts.change_pagelang
:no-members:
-coordinate\_import script
--------------------------
+coordinate\_import script description
+-------------------------------------
.. automodule:: scripts.coordinate_import
:no-members:
-delinker script
----------------
+delinker script description
+---------------------------
.. automodule:: scripts.delinker
:no-members:
-djvutext script
----------------
+djvutext script description
+---------------------------
.. automodule:: scripts.djvutext
:no-members:
-download\_dump script
----------------------
+download\_dump script description
+---------------------------------
.. automodule:: scripts.download_dump
:no-members:
-fixing\_redirects script
-------------------------
+fixing\_redirects script description
+------------------------------------
.. automodule:: scripts.fixing_redirects
:no-members:
-misspelling script
-------------------
+misspelling script description
+------------------------------
.. automodule:: scripts.misspelling
:no-members:
-noreferences script
--------------------
+noreferences script description
+-------------------------------
.. automodule:: scripts.noreferences
:no-members:
-parser\_function\_count script
-------------------------------
+parser\_function\_count script description
+------------------------------------------
.. automodule:: scripts.parser_function_count
:no-members:
-reflinks script
----------------
+reflinks script description
+---------------------------
.. automodule:: scripts.reflinks
:no-members:
-replicate\_wiki script
-----------------------
+replicate\_wiki script description
+----------------------------------
.. automodule:: scripts.replicate_wiki
:no-members:
-watchlist script
-----------------
+watchlist script description
+----------------------------
.. automodule:: scripts.watchlist
:no-members:
diff --git a/docs/scripts/wikibase.rst b/docs/scripts/wikibase.rst
index 63f621e..c604030 100644
--- a/docs/scripts/wikibase.rst
+++ b/docs/scripts/wikibase.rst
@@ -1,38 +1,38 @@
Wikibase scripts
================
-claimit script
---------------
+claimit script description
+--------------------------
.. automodule:: scripts.claimit
:no-members:
-dataextend script
------------------
+dataextend script description
+-----------------------------
.. automodule:: scripts.dataextend
:no-members:
-harvest\_template script
-------------------------
+harvest\_template script description
+------------------------------------
.. automodule:: scripts.harvest_template
:no-members:
-illustrate\_wikidata script
----------------------------
+illustrate\_wikidata script description
+---------------------------------------
.. automodule:: scripts.illustrate_wikidata
:no-members:
-interwikidata script
---------------------
+interwikidata script description
+--------------------------------
.. automodule:: scripts.interwikidata
:no-members:
-newitem script
---------------
+newitem script description
+--------------------------
.. automodule:: scripts.newitem
:no-members:
diff --git a/pywikibot/textlib.py b/pywikibot/textlib.py
index 7425d44..0318b3d 100644
--- a/pywikibot/textlib.py
+++ b/pywikibot/textlib.py
@@ -486,6 +486,7 @@
.. versionchanged:: 7.0
the order of removals will correspond to the tags argument
if provided as an ordered collection (list, tuple)
+
:param tags: The exact set of parts which should be removed using
keywords from textlib._get_regexes().
:param include: Or, in alternative, default parts that shall not
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/785814
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I89f3871b4ad43d9e45b1923425c1ec7562f78ba9
Gerrit-Change-Number: 785814
Gerrit-PatchSet: 1
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]
