diff --git a/CHANGES b/CHANGES index f0a4c2bb9..514b0b67f 100644 --- a/CHANGES +++ b/CHANGES @@ -610,7 +610,7 @@ Release 2.4.1 (released Feb 11, 2020) Bugs fixed ---------- -* #7120: html: crashed when on scaling SVG images which have float dimentions +* #7120: html: crashed when on scaling SVG images which have float dimensions * #7126: autodoc: TypeError: 'getset_descriptor' object is not iterable Release 2.4.0 (released Feb 09, 2020) @@ -756,7 +756,7 @@ Features added * #6548: html: Use favicon for OpenSearch if available * #6729: html theme: agogo theme now supports ``rightsidebar`` option * #6780: Add PEP-561 Support -* #6762: latex: Allow to load additonal LaTeX packages via ``extrapackages`` key +* #6762: latex: Allow to load additional LaTeX packages via ``extrapackages`` key of :confval:`latex_elements` * #1331: Add new config variable: :confval:`user_agent` * #6000: LaTeX: have backslash also be an inline literal word wrap break diff --git a/EXAMPLES b/EXAMPLES index 7911b7cef..b87d8e73e 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -355,7 +355,7 @@ Documentation using a custom theme or integrated in a website * `Roundup `__ * `SaltStack `__ * `scikit-learn `__ -* `SciPy `__ +* `SciPy `__ * `Scrapy `__ * `Seaborn `__ * `Selenium `__ diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index f26a1ba9f..95f9ab8ed 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -388,7 +388,7 @@ class EpubBuilder(StandaloneHTMLBuilder): return ext in VECTOR_GRAPHICS_EXTENSIONS def copy_image_files_pil(self) -> None: - """Copy images using Pillow, the Python Imaging Libary. + """Copy images using Pillow, the Python Imaging Library. The method tries to read and write the files with Pillow, converting the format and resizing the image if necessary/possible. """ diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index 3f6c51b26..642fee55e 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -3508,7 +3508,7 @@ class CXRefRole(XRefRole): config=self.env.config) try: parser.parse_xref_object() - # it suceeded, so let it through + # it succeeded, so let it through return super().run() except DefinitionError as eOrig: # try as if it was an c:expr diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 38c84898b..2348fb76b 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -141,7 +141,7 @@ T = TypeVar('T') visibility storage-class-specifier function-specifier "friend" "constexpr" "volatile" "const" trailing-type-specifier # where trailing-type-specifier can no be cv-qualifier - # Inside e.g., template paramters a strict subset is used + # Inside e.g., template parameters a strict subset is used # (see type-specifier-seq) trailing-type-specifier -> simple-type-specifier -> diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 6c75f8dd7..dc7d610c2 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -149,7 +149,7 @@ class JSObject(ObjectDescription): :py:class:`JSObject` represents JavaScript language constructs. For constructs that are nestable, this method will build up a stack of the - nesting heirarchy so that it can be later de-nested correctly, in + nesting hierarchy so that it can be later de-nested correctly, in :py:meth:`after_content`. For constructs that aren't nestable, the stack is bypassed, and instead diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index eb7d79f81..fb167828f 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -480,7 +480,7 @@ class PyObject(ObjectDescription): :py:class:`PyObject` represents Python language constructs. For constructs that are nestable, such as a Python classes, this method will - build up a stack of the nesting heirarchy so that it can be later + build up a stack of the nesting hierarchy so that it can be later de-nested correctly, in :py:meth:`after_content`. For constructs that aren't nestable, the stack is bypassed, and instead diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 0e652509f..bae4554cf 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -62,7 +62,7 @@ def process_ifconfig_nodes(app: Sphinx, doctree: nodes.document, docname: str) - # handle exceptions in a clean fashion from traceback import format_exception_only msg = ''.join(format_exception_only(err.__class__, err)) - newnode = doctree.reporter.error('Exception occured in ' + newnode = doctree.reporter.error('Exception occurred in ' 'ifconfig expression: \n%s' % msg, base_node=node) node.replace_self(newnode) diff --git a/sphinx/search/da.py b/sphinx/search/da.py index b04679e10..b68eacb79 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -63,7 +63,7 @@ hvor | where eller | or hvad | what skal | must/shall etc. -selv | myself/youself/herself/ourselves etc., even +selv | myself/yourself/herself/ourselves etc., even her | here alle | all/everyone/everybody etc. vil | will (verb) diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index 9c0e30394..babd5904d 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -52,7 +52,7 @@ russian_stopwords = parse_stop_word(''' от | away from меня | me еще | still, yet, more -нет | no, there isnt/arent +нет | no, there isn't/aren't о | about из | out of ему | to him diff --git a/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js b/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js index f21dd4949..787862027 100644 --- a/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js +++ b/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js @@ -1035,7 +1035,7 @@ domReady(function enableCssMediaQueries() { var vpw = cssHelper.getViewportWidth(); var vph = cssHelper.getViewportHeight(); // check whether vp size has really changed, because IE also triggers resize event when body size changes - // 20px allowance to accomodate short appearance of scrollbars in IE in some cases + // 20px allowance to accommodate short appearance of scrollbars in IE in some cases if (Math.abs(vpw - cvpw) > scrollbarWidth || Math.abs(vph - cvph) > scrollbarWidth) { cvpw = vpw; cvph = vph; diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index a864bb97a..082c5caa3 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -328,7 +328,7 @@ def get_full_modname(modname: str, attribute: str) -> str: return None module = import_module(modname) - # Allow an attribute to have multiple parts and incidentially allow + # Allow an attribute to have multiple parts and incidentally allow # repeated .s in the attribute. value = module for attr in attribute.split('.'): diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 4923343ae..7c55c4ec7 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -27,7 +27,7 @@ def register_application_for_autosummary(app: "Sphinx") -> None: """Register application object to autosummary module. Since Sphinx-1.7, documenters and attrgetters are registered into - applicaiton object. As a result, the arguments of + application object. As a result, the arguments of ``get_documenter()`` has been changed. To keep compatibility, this handler registers application object to the module. """ diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index 1f8fabf23..ce299d27a 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -497,7 +497,7 @@ def new_document(source_path: str, settings: Any = None) -> nodes.document: """Return a new empty document object. This is an alternative of docutils'. This is a simple wrapper for ``docutils.utils.new_document()``. It - caches the result of docutils' and use it on second call for instanciation. + caches the result of docutils' and use it on second call for instantiation. This makes an instantiation of document nodes much faster. """ global __document_cache__ diff --git a/sphinx/versioning.py b/sphinx/versioning.py index 502bf361c..7307b13d1 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -116,7 +116,7 @@ def merge_doctrees(old: Node, new: Node, condition: Any) -> Iterator[Node]: def get_ratio(old: str, new: str) -> float: - """Return a "similiarity ratio" (in percent) representing the similarity + """Return a "similarity ratio" (in percent) representing the similarity between the two strings where 0 is equal and anything above less than equal. """ if not all([old, new]): diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 485bc010c..796362260 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -74,7 +74,7 @@ class Table: Cell spanning on multiple rows or multiple columns (having a colspan or rowspan greater than one) are automatically referenced - by all the table cells they covers. This is a usefull + by all the table cells they covers. This is a useful representation as we can simply check ``if self[x, y] is self[x, y+1]`` to recognize a rowspan. diff --git a/tests/roots/test-latex-labels/index.rst b/tests/roots/test-latex-labels/index.rst index 781db5a01..f3c421750 100644 --- a/tests/roots/test-latex-labels/index.rst +++ b/tests/roots/test-latex-labels/index.rst @@ -69,4 +69,4 @@ subsubsection otherdoc -* Embeded standalone hyperlink reference(refs: #5948): `subsection `_. +* Embedded standalone hyperlink reference(refs: #5948): `subsection `_. diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 3bf6edd66..8dbe2a48c 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -1477,7 +1477,7 @@ def test_latex_labels(app, status, warning): r'\label{\detokenize{otherdoc:otherdoc}}' r'\label{\detokenize{otherdoc::doc}}' in result) - # Embeded standalone hyperlink reference (refs: #5948) + # Embedded standalone hyperlink reference (refs: #5948) assert result.count(r'\label{\detokenize{index:section1}}') == 1 diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py index 3125f2c6e..2ecb3f4e4 100644 --- a/tests/test_ext_inheritance_diagram.py +++ b/tests/test_ext_inheritance_diagram.py @@ -109,7 +109,7 @@ def test_inheritance_diagram(app, status, warning): ('dummy.test.B', 'dummy.test.B', [], None) ] - # inheritance diagram with 2 top classes and specifiying the entire module + # inheritance diagram with 2 top classes and specifying the entire module # rendering should be # # A diff --git a/utils/pylintrc b/utils/pylintrc index cf71db595..c2b338b79 100644 --- a/utils/pylintrc +++ b/utils/pylintrc @@ -1,6 +1,6 @@ # lint Python modules using external checkers. # -# This is the main checker controling the other ones and the reports +# This is the main checker controlling the other ones and the reports # generation. It is itself both a raw checker and an astng checker in order # to: # * handle message activation / deactivation at the module level @@ -71,7 +71,7 @@ reports=yes # Python expression which should return a note less than 10 (10 is the highest # note).You have access to the variables errors warning, statement which -# respectivly contain the number of errors / warnings messages and the total +# respectively contain the number of errors / warnings messages and the total # number of statements analyzed. This is used by the global evaluation report # (R0004). evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)