jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1336090?usp=email )
Change subject: docs: Fix typos and grammatical errors
......................................................................
docs: Fix typos and grammatical errors
Correct 15 wording errors in guides, API docstrings and comments,
including subject-verb agreement, missing words and verb forms.
Clarify that encode_url encodes its query parameters.
Change-Id: I3fcb6a16fe877659e59224f9c621f9f51b4db53b
---
M docs/entrypoint.rst
M docs/faq.rst
M docs/glossary.rst
M docs/introduction.rst
M docs/library_usage.rst
M pywikibot/data/api/_requests.py
M pywikibot/date.py
M pywikibot/page/_basepage.py
M pywikibot/tools/__init__.py
M scripts/blockpageschecker.py
M scripts/maintenance/cache.py
11 files changed, 15 insertions(+), 15 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/docs/entrypoint.rst b/docs/entrypoint.rst
index 30c75e2..abc2432 100644
--- a/docs/entrypoint.rst
+++ b/docs/entrypoint.rst
@@ -91,7 +91,7 @@
pwb <global options> show_entities <scripts options>
-.. note:: If you have several Pywikibot scripts installed, there script names
- must be different; otherwise the started script might not that you have
+.. note:: If you have several Pywikibot scripts installed, their script names
+ must be different; otherwise the started script might not be the one you
expected.
.. warning:: This guide is not tested. Test it locally before uploading to
pypi.
diff --git a/docs/faq.rst b/docs/faq.rst
index 483909c..667bd2c 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -21,10 +21,10 @@
available and appropriate. See also: :manpage:`MySQL`
**The bot cannot delete pages**
- Your account needs delete rights on your wiki. If you have setup another
+ Your account needs delete rights on your wiki. If you have set up another
account in your user_config use ``-user``
:ref:`global options` to change it.
- Maybe you have to login first.
+ Maybe you have to log in first.
**ERROR: Unable to execute script because no *generator* was defined.**
Using ``-help`` option is a good way to find all generators which can be
diff --git a/docs/glossary.rst b/docs/glossary.rst
index 73b0a5a..62fa365 100644
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@@ -16,7 +16,7 @@
compat
The first Pywikibot package formerly known as *Pywikipediabot*
also called :term:`trunk` was started in 2003. MediaWiki didn't
- have an API so a :wiki:`screen scrapping<Screen_scraper>` was used.
+ have an API so a :wiki:`screen scraper<Screen_scraper>` was used.
core
In 2007 a new branch of Pywikibot formerly known as
@@ -44,7 +44,7 @@
**Py**\ thon Media\ **Wiki Bot** Framework, a Python library and
collection of scripts that automate work on MediaWiki sites.
Originally designed for Wikipedia, it is now used throughout the
- Wikimedia Foundation's projects and on many other wikis based of
+ Wikimedia Foundation's projects and on many other wikis based on
MediaWiki software.
rewrite
@@ -52,7 +52,7 @@
stable
A stable branch of Pywikibot updated roughly every month
- after tests passes. This branch is preinstalled at :term:`PAWS`
+ after tests pass. This branch is preinstalled at :term:`PAWS`
and should be used for production systems.
tag
diff --git a/docs/introduction.rst b/docs/introduction.rst
index de11f04..731c112 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -32,7 +32,7 @@
#. set the `userinterface_lang` in your :ref:`user-config.py<User Interface
Settings>` to your preferred language
#. set environment variable `PYWIKIBOT_USERINTERFACE_LANG` to your preferred
language
#. default is obtained from `locale.getlocale`
-#. fallback is `'en'` for English if all other options fails
+#. fallback is `'en'` for English if all other options fail
.. note:: The preferred language code must follow ISO 639.
.. version-added:: 7.0
diff --git a/docs/library_usage.rst b/docs/library_usage.rst
index 7ca3b5f..839c1e4 100644
--- a/docs/library_usage.rst
+++ b/docs/library_usage.rst
@@ -58,7 +58,7 @@
:class:`bot.ExistingPageBot`.
:5: The bot is derived from
:class:`ExistingPageBot<bot.ExistingPageBot>`.
- All pages from generator which does not exists are skipped.
+ All pages from the generator that do not exist are skipped.
:7: Every Bot has an *always* option which autoconfirms any changes if
set to True. To expand all available options of a bot and set the
default values of them, use
diff --git a/pywikibot/data/api/_requests.py b/pywikibot/data/api/_requests.py
index e64fbe7..0c83aee 100644
--- a/pywikibot/data/api/_requests.py
+++ b/pywikibot/data/api/_requests.py
@@ -1408,7 +1408,7 @@
:py:obj:`urlencode`. Return an HTTP URL query fragment which
complies with :api:`Edit#Parameters` (See the 'token' bullet.)
- :param query: keys and values to be uncoded for passing with a url
+ :param query: keys and values to be encoded for passing with a url
:type query: mapping object or a sequence of two-element tuples
:return: encoded parameters with token parameters at the end
"""
diff --git a/pywikibot/date.py b/pywikibot/date.py
index 0df0024..7887ad5 100644
--- a/pywikibot/date.py
+++ b/pywikibot/date.py
@@ -1964,7 +1964,7 @@
with suppress(Exception):
year = dictionary[lang](title)
return dict_name, year
- # sometimes the title may begin with an upper case while its listed as
+ # sometimes the title may begin with an upper case while it's listed as
# lower case, or the other way around
# change case of the first character to the opposite, and try again
if ignoreFirstLetterCase:
diff --git a/pywikibot/page/_basepage.py b/pywikibot/page/_basepage.py
index 020c5d1..9a891b6 100644
--- a/pywikibot/page/_basepage.py
+++ b/pywikibot/page/_basepage.py
@@ -1152,7 +1152,7 @@
namespaces=None,
total: int | None = None,
content: bool = False) -> Iterable[pywikibot.Page]:
- """Return an iterator all pages that refer to or embed the page.
+ """Return an iterator over all pages that refer to or embed the page.
If you need a full list of referring pages, use
``pages = list(s.getReferences())``
diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py
index bf6e8ff..9e5952a 100644
--- a/pywikibot/tools/__init__.py
+++ b/pywikibot/tools/__init__.py
@@ -434,7 +434,7 @@
"""Version object to allow comparing 'wmf' versions with normal ones.
- The version mainly consist of digits separated by periods. After
+ The version mainly consists of digits separated by periods. After
that is a suffix which may only be 'wmf<number>', 'alpha',
'beta<number>' or '-rc.<number>' (the - and . are optional). They
are considered from old to new in that order with a version number
diff --git a/scripts/blockpageschecker.py b/scripts/blockpageschecker.py
index d689e0f..88d7b8f 100755
--- a/scripts/blockpageschecker.py
+++ b/scripts/blockpageschecker.py
@@ -124,7 +124,7 @@
}
# If you use only one template for all the type of protection, put it here.
-# You may use only one template or an unique template and some other "old"
+# You may use only one template or a unique template and some other "old"
# template that the script should still check (as on it.wikipedia)
template_unique = {
'ar': [r'\{\{(?:[Tt]emplate:|قالب:|)(محمية)\}\}'],
diff --git a/scripts/maintenance/cache.py b/scripts/maintenance/cache.py
index b97ad6f..8849f2e 100755
--- a/scripts/maintenance/cache.py
+++ b/scripts/maintenance/cache.py
@@ -80,7 +80,7 @@
import pywikibot
from pywikibot.data import api
-# The follow attributes are used by eval()
+# The following attributes are used by eval()
from pywikibot.login import LoginStatus # noqa: F401
from pywikibot.page import User # noqa: F401
from pywikibot.site import APISite, ClosedSite, DataSite # noqa: F401
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1336090?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: I3fcb6a16fe877659e59224f9c621f9f51b4db53b
Gerrit-Change-Number: 1336090
Gerrit-PatchSet: 2
Gerrit-Owner: Mahveotm <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]