Skip to content

Commit 999f726

Browse files
committed
improved documentation for version 1.3
1 parent 3cff2fc commit 999f726

File tree

3 files changed

+19
-12
lines changed

3 files changed

+19
-12
lines changed

docs/index.rst

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,14 @@ Featured scripts
4343
updates the interlanguage links based on the ArchWiki's `interlanguage map`_
4444
and fixes categories of local pages.
4545
- ``link-checker.py``
46-
parses all pages on the wiki and tries to fix broken wikilinks, simplify
47-
links over redirects and relative links, and to beautify them based on
48-
ArchWiki's `style recommendations`_.
46+
parses all pages on the wiki and tries to fix various functional and `stylistic`_
47+
issues with wikilinks, external links and manual page links.
48+
- ``url-replace.py``
49+
parses all pages on the wiki and performs various replacements on external
50+
link URLs. This functionality is also included in ``link-checker.py``.
51+
- ``extlink-checker.py``
52+
parses all pages and checks if external links are accessible and marks them
53+
with the `Dead link`_ template if they are clearly broken.
4954
- ``statistics.py``
5055
generates automatic updates to the `ArchWiki:Statistics`_ page.
5156
- ``toc.py``
@@ -59,13 +64,14 @@ For a full list of available scripts see the `root directory`_ in the git
5964
repository. The `examples directory`_ contains less notable notable scripts
6065
showing various ways of the core :py:mod:`ws` module usage.
6166

62-
.. _`interlanguage map`: https://wiki.archlinux.org/index.php/Help:I18n
63-
.. _`style recommendations`: https://wiki.archlinux.org/index.php/Help:Style
64-
.. _`ArchWiki:Statistics`: https://wiki.archlinux.org/index.php/ArchWiki:Statistics
65-
.. _`Table of contents`: https://wiki.archlinux.org/index.php/Table_of_contents
66-
.. _`AUR`: https://wiki.archlinux.org/index.php/Template:AUR
67-
.. _`Grp`: https://wiki.archlinux.org/index.php/Template:Grp
68-
.. _`Pkg`: https://wiki.archlinux.org/index.php/Template:Pkg
67+
.. _`interlanguage map`: https://wiki.archlinux.org/title/Help:I18n
68+
.. _`stylistic`: https://wiki.archlinux.org/title/Help:Style
69+
.. _`ArchWiki:Statistics`: https://wiki.archlinux.org/title/ArchWiki:Statistics
70+
.. _`Table of contents`: https://wiki.archlinux.org/title/Table_of_contents
71+
.. _`Dead link`: https://wiki.archlinux.org/title/Template:Dead_link
72+
.. _`AUR`: https://wiki.archlinux.org/title/Template:AUR
73+
.. _`Grp`: https://wiki.archlinux.org/title/Template:Grp
74+
.. _`Pkg`: https://wiki.archlinux.org/title/Template:Pkg
6975
.. _`root directory`: https://github.com/lahwaacz/wiki-scripts
7076
.. _`examples directory`: https://github.com/lahwaacz/wiki-scripts/blob/master/examples
7177

ws/client/api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ def call_api_autoiter_ids(self, params=None, *, expand_result=True, **kwargs):
190190
:py:attr:`API.max_ids_per_query`.
191191
192192
Note that this is applicable only to the ``titles``, ``pageids`` and
193-
``revids`` API parameters which have to be supplied as :py:type:`list`
194-
or :py:type:`set` to this method. Exactly one of these parameters has
193+
``revids`` API parameters which have to be supplied as :py:class:`!list`
194+
or :py:class:`set` to this method. Exactly one of these parameters has
195195
to be supplied.
196196
197197
The parameters have the same meaning as those in the

ws/db/database.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ def sync_revisions_content(self, api, *, mode="latest"):
155155
156156
:param ws.client.api.API api: interface to the remote MediaWiki instance
157157
:param str mode: the mode of operation:
158+
158159
- `"latest"`: the content of the latest revisions of all pags on
159160
the wiki will be synchronized
160161
- `"all"`: the content of all revisions will be synchronized

0 commit comments

Comments
 (0)