jenkins-bot submitted this change.
[doc] Update documentation of scripts
Change-Id: I2809512eda5fb6e40908359a41e7a733ccb2ff7b
---
M scripts/change_pagelang.py
M scripts/download_dump.py
2 files changed, 17 insertions(+), 15 deletions(-)
diff --git a/scripts/change_pagelang.py b/scripts/change_pagelang.py
index d977639..473b785 100755
--- a/scripts/change_pagelang.py
+++ b/scripts/change_pagelang.py
@@ -1,8 +1,8 @@
#!/usr/bin/env python3
-"""
-This script changes the content language of pages.
+"""This script changes the content language of pages.
-These command line parameters can be used to specify which pages to work on:
+These command line parameters can be used to specify which pages to work
+on:
¶ms;
@@ -10,18 +10,20 @@
-setlang What language the pages should be set to
--always If a language is already set for a page, always change it
- to the one set in -setlang.
+-always If a language is already set for a page, always change
+ it to the one set in -setlang.
--never If a language is already set for a page, never change it to
- the one set in -setlang (keep the current language).
+-never If a language is already set for a page, never change
+ it to the one set in -setlang (keep the current
+ language).
.. note:: This script is a
- :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
- can be set within a settings file which is scripts.ini by default.
+ :class:`ConfigParserBot<bot.ConfigParserBot>`. All options can be set
+ within a settings file which is scripts.ini by default.
+.. versionadded:: 5.1
"""
#
-# (C) Pywikibot team, 2018-2023
+# (C) Pywikibot team, 2018-2024
#
# Distributed under the terms of the MIT license.
#
diff --git a/scripts/download_dump.py b/scripts/download_dump.py
index 8fb42f7..f374923 100755
--- a/scripts/download_dump.py
+++ b/scripts/download_dump.py
@@ -1,6 +1,5 @@
#!/usr/bin/env python3
-"""
-This bot downloads dump from dumps.wikimedia.org.
+"""This bot downloads dump from dumps.wikimedia.org.
This script supports the following command line parameters:
@@ -12,11 +11,12 @@
formatted as YYYYMMDD.
.. note:: This script is a
- :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
- can be set within a settings file which is scripts.ini by default.
+ :class:`ConfigParserBot<bot.ConfigParserBot>`. All options can be set
+ within a settings file which is scripts.ini by default.
+.. versionadded:: 3.0.20180108
"""
#
-# (C) Pywikibot team, 2017-2022
+# (C) Pywikibot team, 2017-2024
#
# Distributed under the terms of the MIT license.
#
To view, visit change 1030528. To unsubscribe, or for help writing mail filters, visit settings.