Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos newly found by codespell #11735

Merged
merged 4 commits into from
Jan 4, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Here are some of Sphinx's major features:
<builtin-extensions>`, and much more functionality via :ref:`third-party
extensions <third-party-extensions>`.
* **Themes:** modify the look and feel of outputs via :doc:`creating themes
<development/theming>`, and re-use many :ref:`third-party themes
<development/theming>`, and reuse many :ref:`third-party themes
AA-Turner marked this conversation as resolved.
Show resolved Hide resolved
<third-party-themes>`.
* **Contributed extensions:** dozens of extensions :ref:`contributed by users
<third-party-extensions>`; most of them installable from PyPI.
Expand Down
2 changes: 1 addition & 1 deletion doc/latex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ Keys that don't need to be overridden unless in special cases are:

.. versionchanged:: 1.8.3
Original ``\maketitle`` from document class is not overwritten,
hence is re-usable as part of some custom setting for this key.
hence is reusable as part of some custom setting for this key.
DimitriPapadopoulos marked this conversation as resolved.
Show resolved Hide resolved

.. versionadded:: 1.8.3
``\sphinxbackoftitlepage`` optional macro. It can also be defined
Expand Down
4 changes: 2 additions & 2 deletions doc/usage/domains/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ The following directives are provided for module and class contents:

.. rst:directive:: .. py:exception:: name
.. py:exception:: name(parameters)
.. py:exception:: name[type parmeters](parameters)
.. py:exception:: name[type parameters](parameters)

Describes an exception class.
The signature can, but need not include parentheses with constructor arguments,
Expand Down Expand Up @@ -192,7 +192,7 @@ The following directives are provided for module and class contents:

.. rst:directive:: .. py:class:: name
.. py:class:: name(parameters)
.. py:class:: name[type parmeters](parameters)
.. py:class:: name[type parameters](parameters)

Describes a class.
The signature can optionally include type parameters (see :pep:`695`)
Expand Down
4 changes: 2 additions & 2 deletions doc/usage/extensions/coverage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ should check:

.. confval:: coverage_statistics_to_report

Print a tabluar report of the coverage statistics to the coverage report.
Print a tabular report of the coverage statistics to the coverage report.
``True`` by default.

Example output:
Expand All @@ -81,7 +81,7 @@ should check:

.. confval:: coverage_statistics_to_stdout

Print a tabluar report of the coverage statistics to standard output.
Print a tabular report of the coverage statistics to standard output.
``False`` by default.

Example output:
Expand Down
2 changes: 1 addition & 1 deletion doc/usage/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ its :doc:`significant extensibility capabilities </development/index>`.
The goal of this document is to give you a quick taste of what Sphinx is and
how you might use it. When you're done here, you can check out the
:doc:`installation guide </usage/installation>` followed by the intro to the
default markup format used by Sphinx, :doc:`reStucturedText
default markup format used by Sphinx, :doc:`reStructuredText
</usage/restructuredtext/index>`.

For a great "introduction" to writing docs in general -- the whys and hows, see
Expand Down
2 changes: 1 addition & 1 deletion doc/usage/restructuredtext/roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -293,5 +293,5 @@ default. They are set in the build configuration file.
.. describe:: |translation progress|

Replaced by the translation progress of the document.
This substitution is intented for use by document translators
This substitution is intended for use by document translators
as a marker for the translation progress of the document.
4 changes: 2 additions & 2 deletions sphinx/domains/cpp.py
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@
abstract-declarator[opt]
# Drop the attributes
-> decl-specifier-seq abstract-declarator[opt]
grammar, typedef-like: no initilizer
grammar, typedef-like: no initializer
decl-specifier-seq declarator
Can start with a templateDeclPrefix.

Expand Down Expand Up @@ -7071,7 +7071,7 @@ def _check_template_consistency(self, nestedName: ASTNestedName,
else:
numParams = len(templatePrefix.templates)
if numArgs + 1 < numParams:
self.fail("Too few template argument lists comapred to parameter"
self.fail("Too few template argument lists compared to parameter"
" lists. Argument lists: %d, Parameter lists: %d."
% (numArgs, numParams))
if numArgs > numParams:
Expand Down
2 changes: 1 addition & 1 deletion sphinx/environment/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ def setup(self, app: Sphinx) -> None:
# initialize config
self._update_config(app.config)

# initialie settings
# initialize settings
self._update_settings(app.config)

def _update_config(self, config: Config) -> None:
Expand Down
2 changes: 1 addition & 1 deletion sphinx/ext/autosummary/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -803,7 +803,7 @@ def process_generate_options(app: Sphinx) -> None:

suffix = get_rst_suffix(app)
if suffix is None:
logger.warning(__('autosummary generats .rst files internally. '
logger.warning(__('autosummary generates .rst files internally. '
DimitriPapadopoulos marked this conversation as resolved.
Show resolved Hide resolved
'But your source_suffix does not contain .rst. Skipped.'))
return

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/ar/LC_MESSAGES/sphinx.po
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of the .po files can be excluded from the spelling checker, they're automatically updated from the source.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what I thought, but I had been told otherwise in #11735 (comment).

Any way, these updates are in a separate commit, they would be easy to discard.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we change a localized string, I think what is autogenerated is an empty translation, hence we probably need to manually update translations in this case but I may be wrong.

Original file line number Diff line number Diff line change
Expand Up @@ -3011,7 +3011,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/bg/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/bn/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/ca/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3013,7 +3013,7 @@ msgstr "autosummary_generate: no s'ha trobat el fitxer: %s"

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr "autosummary genera els fitxers .rst internament. Però el vostre source_suffix no en conté. S'omet."

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/cak/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/cs/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3011,7 +3011,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/cy/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3011,7 +3011,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/da/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3013,7 +3013,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/de/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3013,7 +3013,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/de_DE/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/el/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3012,7 +3012,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr "Το autosummary δημιουργεί αρχεία .rst εσωτερικά. Αλλά το δικό σας source_suffix δεν περιλαμβάνει .rst. Θα παραλειφθεί."

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/en_DE/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/en_FR/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
4 changes: 2 additions & 2 deletions sphinx/locale/en_GB/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3010,9 +3010,9 @@ msgstr "autosummary_generate: file not found: %s"

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr "autosummary generats .rst files internally. But your source_suffix does not contain .rst. Skipped."
msgstr "autosummary generates .rst files internally. But your source_suffix does not contain .rst. Skipped."

#: sphinx/ext/autosummary/generate.py:200
#: sphinx/ext/autosummary/generate.py:358
Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/en_HK/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/eo/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3011,7 +3011,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/es/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3018,7 +3018,7 @@ msgstr "autosummary_generate: archivo no encontrado: %s"

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr "autosummary genera archivos .rst internamente. Pero su source_suffix no contiene archivo .rst. Saltado."

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/es_CO/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/et/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3013,7 +3013,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/eu/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3011,7 +3011,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/fa/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3013,7 +3013,7 @@ msgstr "تولید خلاصه خودکار: پرونده پیدا نشد: %s"

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr "خلاصه‌ی خودکار به طور داخلی پرونده‌های rst را ایجاد می‌کند. ولی پسوند منبع شما شامل rst نیست. نادیده گرفته می‌شود."

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/fi/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/fr/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3037,7 +3037,7 @@ msgstr "autosummary_generate : fichier nontrouvé : %s"

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr "autosummary engendre les fichiers .rst de manière interne. Mais votre source_suffix ne contient pas .rst. Ignoré."

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/fr_FR/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/gl/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/he/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/hi/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3013,7 +3013,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr "ऑटोसमरी आतंरिक रूप से आर.एस.टी. फाइलें बनाता है. आपके सोर्स_सफिक्स में आर.एस.टी. सम्मिलित नहीं है. छोड़ा गया."

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/hi_IN/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/hr/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/hu/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3015,7 +3015,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/id/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3015,7 +3015,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr "autosummary menghasilkan file .rst secara internal. Tapi source_suffix Anda tidak mengandung .rst. Dilewati."

Expand Down
2 changes: 1 addition & 1 deletion sphinx/locale/is/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@ msgstr ""

#: sphinx/ext/autosummary/__init__.py:806
msgid ""
"autosummary generats .rst files internally. But your source_suffix does not "
"autosummary generates .rst files internally. But your source_suffix does not "
"contain .rst. Skipped."
msgstr ""

Expand Down