From 55f6c8e496e17635fc7eb2e24ea2fe112b479373 Mon Sep 17 00:00:00 2001 From: luz paz Date: Sun, 30 Jan 2022 08:42:29 -0500 Subject: [PATCH] Fix various typos MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Found via `codespell -q 3 -L nd,te` Co-authored-by: Vladimír Vondruš --- doc/admire/math.rst | 2 +- doc/css/components.rst | 2 +- doc/css/page-layout.rst | 2 +- doc/css/themes.rst | 4 ++-- doc/documentation/doxygen.rst | 14 +++++++------- doc/documentation/python.rst | 10 +++++----- doc/plugins.rst | 2 +- doc/plugins/htmlsanity.rst | 6 +++--- doc/themes/pelican.rst | 12 ++++++------ documentation/_search.py | 2 +- documentation/doxygen.py | 6 +++--- documentation/python.py | 4 ++-- documentation/test/test_search.py | 2 +- .../test_doxygen/contents_blocks/input.dox | 2 +- .../test_doxygen/contents_blocks/todo.html | 2 +- .../test_doxygen/contents_blocks/todo_1814.html | 2 +- .../contents_unexpected_sections/File.h | 4 ++-- documentation/test_doxygen/cpp_friends/File.h | 4 ++-- .../cpp_function_attributes/classDerived.html | 2 +- .../test_doxygen/cpp_function_attributes/input.h | 2 +- documentation/test_python/__init__.py | 2 +- .../test_python/content/content/__init__.py | 2 +- documentation/test_python/page/another.html | 2 +- documentation/test_python/page/another.rst | 2 +- documentation/test_python/page/pages.html | 2 +- pelican-theme/test/test_blog.py | 2 +- plugins/m/images.py | 2 +- plugins/m/sphinx.py | 2 +- plugins/m/test/code/page.html | 2 +- plugins/m/test/code/page.rst | 2 +- 30 files changed, 53 insertions(+), 53 deletions(-) diff --git a/doc/admire/math.rst b/doc/admire/math.rst index 4d0d5cb9..ed6244af 100644 --- a/doc/admire/math.rst +++ b/doc/admire/math.rst @@ -97,7 +97,7 @@ m.css math .. button-warning:: {filename}/css/components.rst#math :class: m-fullwidth - See the possibilites + See the possibilities .. container:: m-col-m-4 diff --git a/doc/css/components.rst b/doc/css/components.rst index e92e6ecb..4e5790c1 100644 --- a/doc/css/components.rst +++ b/doc/css/components.rst @@ -1246,7 +1246,7 @@ with :css:`.m-line`, error bars with :css:`.m-error`. Use .. note-info:: - Plot styling is designed to be used with extenal tools, for example Python + Plot styling is designed to be used with external tools, for example Python Matplotlib. If you use Pelican, m.css has a `m.plots <{filename}/plugins/plots-and-graphs.rst#plots>`__ plugin that allows you to produce plots using :rst:`.. plot::` directives directly in diff --git a/doc/css/page-layout.rst b/doc/css/page-layout.rst index 33f61f15..faf6235e 100644 --- a/doc/css/page-layout.rst +++ b/doc/css/page-layout.rst @@ -420,7 +420,7 @@ the fold", *not* the cover image.
- +
diff --git a/doc/css/themes.rst b/doc/css/themes.rst index 4736fd0f..85480c68 100644 --- a/doc/css/themes.rst +++ b/doc/css/themes.rst @@ -123,8 +123,8 @@ together and it will create a ``*.compiled.css`` file in the same directory: cd css ./postprocess.py m-dark.css # Creates a m-dark.compiled.css file -`Modifying the Pygments higlighting style`_ -------------------------------------------- +`Modifying the Pygments highlighting style`_ +-------------------------------------------- If you want to modify the Pygments style, it's a bit more involved. You need to edit the ``*.py`` file instead of the ``*.css``: diff --git a/doc/documentation/doxygen.rst b/doc/documentation/doxygen.rst index 7e2400f6..a165d4de 100644 --- a/doc/documentation/doxygen.rst +++ b/doc/documentation/doxygen.rst @@ -73,7 +73,7 @@ switch. .. note-info:: - The script requires at least Doxygen 1.8.14, but preferrably version 1.8.15 + The script requires at least Doxygen 1.8.14, but preferably version 1.8.15 and newer. Some features depend on newer versions, in that case the documentation mentions which version contains the support. @@ -205,7 +205,7 @@ In addition to features `shared by all doc generators <{filename}/documentation. This list presents my opinions. Not everybody likes my opinions. -Features that I don't see a point in because they just artifically inflate the +Features that I don't see a point in because they just artificially inflate the amount of generated content for no added value. - Class hierarchy graphs are ignored (it only inflates the documentation with @@ -600,7 +600,7 @@ If the title is :py:`None`, it's taken implicitly from the page it links to. Empty :py:`LINKS_NAVBAR2` will cause the navigation appear in a single column, setting both empty will cause the navbar links to not be rendered at all. -A menu item is higlighted if a compound with the same ID is the current page +A menu item is highlighted if a compound with the same ID is the current page (and similarly for the special ``pages``, ... IDs). Alternatively, a link can be a plain HTML instead of the first pair of tuple @@ -1269,7 +1269,7 @@ rendered HTML output: It's possible to combine ``@par`` with ``@parblock`` to create blocks, notes and other `m.css components <{filename}/css/components.rst>`_ with arbitrary -contents. The ``@par`` command visuals can be fully overriden by putting ``@m_class`` in front, the ``@parblock`` after will ensure everything will +contents. The ``@par`` command visuals can be fully overridden by putting ``@m_class`` in front, the ``@parblock`` after will ensure everything will belong inside. A bit recursive example: .. code-figure:: @@ -1374,7 +1374,7 @@ the page will be discoverable both using its primary title and using *TCB spline support*, in the second and third case the two overloads of the :cpp:`lerp()` function are discoverable also via :cpp:`mix()`, displaying either *GLSL mix()* or *GLSL mix(genType, genType, float)* in the search -results. The last parameter is suffix length, needed to correctly higlight the +results. The last parameter is suffix length, needed to correctly highlight the *mix* substring when there are additional characters at the end of the title. If not specified, it defaults to :cpp:`0`, meaning the search string is a suffix of the title. @@ -1653,9 +1653,9 @@ Filename Use saved as ``*-example.html`` ``file.html`` File documentation, read from ``*.xml`` and saved as ``*.html`` -``namespace.html`` Namespace documentation, read fron ``namespace*.xml`` +``namespace.html`` Namespace documentation, read from ``namespace*.xml`` and saved as ``namespace*.html`` -``group.html`` Module documentation, read fron ``group_*.xml`` +``group.html`` Module documentation, read from ``group_*.xml`` and saved as ``group_*.html`` ``page.html`` Page, read from ``*.xml``/``indexpage.xml`` and saved as ``*.html``/``index.html`` diff --git a/doc/documentation/python.rst b/doc/documentation/python.rst index 2ad2aaf7..1adba6a4 100644 --- a/doc/documentation/python.rst +++ b/doc/documentation/python.rst @@ -203,7 +203,7 @@ Variable Description put into the footer. If not set, a default generic text is used. If empty, no footer is rendered at all. -:py:`FORMATTED_METADATA: List[str]` Which meatadata fields should be formatted +:py:`FORMATTED_METADATA: List[str]` Which metadata fields should be formatted in documentation pages. By default only the ``summary`` field is. :py:`PLUGINS: List[str]` List of `plugins <{filename}/plugins.rst>`_ @@ -504,7 +504,7 @@ In case the autodetection includes more than you want or, conversely, you need to include names that would otherwise be excluded (such as underscored names), you can temporarily override the :py:`__all__` attribute when generating the docs. For example, the following will list just the :py:`pow()` and :py:`log()` -funtions from the :py:`math` module, ignoring the rest: +functions from the :py:`math` module, ignoring the rest: .. code:: py @@ -516,7 +516,7 @@ funtions from the :py:`math` module, ignoring the rest: In other cases, especially when native modules are involved, the inspected name locations might not be what you want. By putting the names into :py:`__all__` you tell the script it should map the inspected location to the one provided. Note you should also hide the original location from the script to avoid -duplicate definitons (unless it's underscored, in which case it'll get ignored +duplicate definitions (unless it's underscored, in which case it'll get ignored automatically). .. code:: py @@ -763,7 +763,7 @@ to :py:`OUTPUT` with the leading dirs stripped from the path. ========== The :abbr:`reST ` content is not limited to just the builtin -functionality and it's possible to extend it via plugins eiter +functionality and it's possible to extend it via plugins either `from m.css itself <{filename}/plugins.rst>`_ or 3rd party ones. See documentation of each plugin to see its usage; the `m.htmlsanity <{filename}/plugins/htmlsanity.rst>`_ plugin is used @@ -981,7 +981,7 @@ Keyword argument Content :py:`css_classes` List of CSS classes to add to the :html:`` tag. Internal entries usually have :py:`['m-doc']` while - exteral have :py:`['m-doc-external']`. + external have :py:`['m-doc-external']`. =================== ======================================= =================== =========================================================== diff --git a/doc/plugins.rst b/doc/plugins.rst index 99a47f4f..a61c1de1 100644 --- a/doc/plugins.rst +++ b/doc/plugins.rst @@ -32,7 +32,7 @@ Plugins In addition to providing a theme for `Pelican <{filename}/themes/pelican.rst>`_ or `Doxygen <{filename}/documentation/doxygen.rst>`_ that styles the overall page layout and basic typography, m.css also contains a collection of plugins, -extending the capabilities futher. +extending the capabilities further. `Usage`_ ======== diff --git a/doc/plugins/htmlsanity.rst b/doc/plugins/htmlsanity.rst index 9f151663..62be561c 100644 --- a/doc/plugins/htmlsanity.rst +++ b/doc/plugins/htmlsanity.rst @@ -131,7 +131,7 @@ Additionally, the following m.css-specific changes are done: - Footnotes and footnote references have the :css:`.m-footnote` `styling classes <{filename}/css/typography.rst#footnotes-and-footnote-references>`_ applied -- Links that are just URLs have :css:`.m-link-wrap` appied `to better wrap on narrow screens <{filename}/css/typography.rst#footnotes-and-footnote-references>`_. +- Links that are just URLs have :css:`.m-link-wrap` applied `to better wrap on narrow screens <{filename}/css/typography.rst#footnotes-and-footnote-references>`_. Note that it's also possible to apply this and other CSS classes explicitly with the `m.link <{filename}/plugins/links.rst#stylable-links>`_ plugin. @@ -186,7 +186,7 @@ included in the :py:`FORMATTED_FIELDS`. See for yourself: *"Autres temps, autres mœurs"* The default language is taken from the standard :py:`DEFAULT_LANG` option, -which defaults to :py:`'en'`, and can be also overriden on per-page or +which defaults to :py:`'en'`, and can be also overridden on per-page or per-article basis using the :rst:`:lang:` metadata option. This feature is controlled by the :py:`M_HTMLSANITY_SMART_QUOTES` option, which, similarly to the builtin :py:`TYPOGRIFY` option, defaults to :py:`False`. @@ -387,7 +387,7 @@ pass language name to the ``lang`` argument. You can also take the value from Sometimes, on the other hand, you might want to de-hyphenate text that was already hyphenated, for example to avoid potential issues in :html:`` -tags. The ``dehyphenate`` filter simply removes all occurences of :html:`­` +tags. The ``dehyphenate`` filter simply removes all occurrences of :html:`­` from passed text. The ``enable`` argument works the same as with the ``hyphenate`` filter. diff --git a/doc/themes/pelican.rst b/doc/themes/pelican.rst index f4af2b0e..53435093 100644 --- a/doc/themes/pelican.rst +++ b/doc/themes/pelican.rst @@ -339,21 +339,21 @@ and `Twitter Card ') and out.parsed.endswith('

') out.parsed = out.parsed[3:-4] - # Strip superfluous

for simple elments (list items, parameter and + # Strip superfluous

for simple elements (list items, parameter and # return value description, table cells), but only if there is just a # single paragraph elif (element.tag in ['listitem', 'parameterdescription', 'entry'] or (element.tag == 'simplesect' and element.attrib['kind'] == 'return')) and not has_block_elements and paragraph_count == 1 and out.parsed: @@ -2535,7 +2535,7 @@ def parse_xml(state: State, xml: str): state.current = os.path.basename(xml) # All these early returns were logged in extract_metadata() already, no - # need to print the same warnings/erorrs twice. Keep the two consistent. + # need to print the same warnings/errors twice. Keep the two consistent. if state.current == 'Doxyfile.html': return @@ -3451,7 +3451,7 @@ def parse_index_xml(state: State, xml): return parsed def parse_doxyfile(state: State, doxyfile, values = None): - # Use top-level Doxyfile path as base, don't let it get overriden by + # Use top-level Doxyfile path as base, don't let it get overridden by # subsequently @INCLUDE'd Doxyfile if not state.basedir: state.basedir = os.path.dirname(doxyfile) diff --git a/documentation/python.py b/documentation/python.py index 64d1a46f..80ee967c 100755 --- a/documentation/python.py +++ b/documentation/python.py @@ -409,7 +409,7 @@ def crawl_class(state: State, path: List[str], class_): if hasattr(previous_entry, 'object') and id(previous_entry.object) == id(class_): break else: assert False, "%s marked as crawled but can't find it" % '.'.join(path) - logging.error("Class %s previously found in %s, only one occurence will be chosen. Ensure each class is exposed only in a single module for generating correct documentation.", '.'.join(path), '.'.join(previous_entry.path)) + logging.error("Class %s previously found in %s, only one occurrence will be chosen. Ensure each class is exposed only in a single module for generating correct documentation.", '.'.join(path), '.'.join(previous_entry.path)) state.name_map['.'.join(path)] = previous_entry return @@ -445,7 +445,7 @@ def crawl_class(state: State, path: List[str], class_): crawl_class(state, subpath, object) - # Crawl enum values (they also add itself ot the name_map) + # Crawl enum values (they also add itself to the name_map) elif type_ == EntryType.ENUM: if is_underscored_and_undocumented(state, type_, subpath, object.__doc__): continue diff --git a/documentation/test/test_search.py b/documentation/test/test_search.py index 7b68d430..98e0c5f1 100755 --- a/documentation/test/test_search.py +++ b/documentation/test/test_search.py @@ -219,7 +219,7 @@ __init__ [{}] def test_23bit_file_offset_too_small(self): trie = Trie() - # The hight bit of the child offset stores a lookahead barrier, so the + # The high bit of the child offset stores a lookahead barrier, so the # file has to be smaller than 8M, not 16. Python has a recursion limit # of 1000, so we can't really insert a 8M character long string. # Instead, insert one 130-character string where each char has 32k diff --git a/documentation/test_doxygen/contents_blocks/input.dox b/documentation/test_doxygen/contents_blocks/input.dox index 22221770..143c7ae7 100644 --- a/documentation/test_doxygen/contents_blocks/input.dox +++ b/documentation/test_doxygen/contents_blocks/input.dox @@ -132,7 +132,7 @@ This gets hidden because internal docs are not enabled by default. /** @page other Other page -@todo Diffferent TODO +@todo Different TODO */ diff --git a/documentation/test_doxygen/contents_blocks/todo.html b/documentation/test_doxygen/contents_blocks/todo.html index c3122dd3..1089bbee 100644 --- a/documentation/test_doxygen/contents_blocks/todo.html +++ b/documentation/test_doxygen/contents_blocks/todo.html @@ -22,7 +22,7 @@

Todo List

-
page Main Page
Or a TODO.
Page Other page
Diffferent TODO
+
page Main Page
Or a TODO.
Page Other page
Different TODO
diff --git a/documentation/test_doxygen/contents_blocks/todo_1814.html b/documentation/test_doxygen/contents_blocks/todo_1814.html index a76ccb8e..3df48ccf 100644 --- a/documentation/test_doxygen/contents_blocks/todo_1814.html +++ b/documentation/test_doxygen/contents_blocks/todo_1814.html @@ -22,7 +22,7 @@

Todo List

-
page Main Page
Or a TODO.
Page Other page
Diffferent TODO
+
page Main Page
Or a TODO.
Page Other page
Different TODO
diff --git a/documentation/test_doxygen/contents_unexpected_sections/File.h b/documentation/test_doxygen/contents_unexpected_sections/File.h index 5c265139..c9571e00 100644 --- a/documentation/test_doxygen/contents_unexpected_sections/File.h +++ b/documentation/test_doxygen/contents_unexpected_sections/File.h @@ -1,11 +1,11 @@ /** @file @brief A file -@return Files don't return anyhting. +@return Files don't return anything. @section section A section -@tparam huh Setions shouldn't have template params. +@tparam huh Sections shouldn't have template params. */ /** diff --git a/documentation/test_doxygen/cpp_friends/File.h b/documentation/test_doxygen/cpp_friends/File.h index f909d7e9..1b84596a 100644 --- a/documentation/test_doxygen/cpp_friends/File.h +++ b/documentation/test_doxygen/cpp_friends/File.h @@ -5,7 +5,7 @@ /** @brief A friend class -Not displayed among @ref Class friends becase Doxygen doesn't provide any +Not displayed among @ref Class friends because Doxygen doesn't provide any useful info for it. */ class FriendClassWarning {}; @@ -13,7 +13,7 @@ class FriendClassWarning {}; /** @brief A friend class -Not displayed among @ref Class friends becase Doxygen doesn't provide any +Not displayed among @ref Class friends because Doxygen doesn't provide any useful info for it. */ class GroupedFriendClassWarning {}; diff --git a/documentation/test_doxygen/cpp_function_attributes/classDerived.html b/documentation/test_doxygen/cpp_function_attributes/classDerived.html index a0964d7d..0c533e58 100644 --- a/documentation/test_doxygen/cpp_function_attributes/classDerived.html +++ b/documentation/test_doxygen/cpp_function_attributes/classDerived.html @@ -51,7 +51,7 @@
void doThing() const override noexcept(…)
-
Do a thing, overriden, now protected.
+
Do a thing, overridden, now protected.
diff --git a/documentation/test_doxygen/cpp_function_attributes/input.h b/documentation/test_doxygen/cpp_function_attributes/input.h index 119c7d5f..cf4472b1 100644 --- a/documentation/test_doxygen/cpp_function_attributes/input.h +++ b/documentation/test_doxygen/cpp_function_attributes/input.h @@ -86,7 +86,7 @@ class Base { /** @brief A derived class */ class Derived: public Base { protected: - /** @brief Do a thing, overriden, now protected */ + /** @brief Do a thing, overridden, now protected */ void doThing() const noexcept(false) override; private: diff --git a/documentation/test_python/__init__.py b/documentation/test_python/__init__.py index bc1ecc34..9dd2f8a8 100644 --- a/documentation/test_python/__init__.py +++ b/documentation/test_python/__init__.py @@ -40,7 +40,7 @@ _camelcase_to_snakecase = re.compile('((?<=[a-z0-9])[A-Z]|(?!^)[A-Z](?=[a-z]))') # filesystem location. For a `test_inspect.NameMapping` class, it will look # for the `inspect_name_mapping` directory. If the class name is equivalent to # the filename (e.g. `test_page.Page`), then it will be looking for just `page` -# instead of `page_page`. If needed, the directory name can be overriden by +# instead of `page_page`. If needed, the directory name can be overridden by # passing it via dir to __init__(). class BaseTestCase(unittest.TestCase): def __init__(self, *args, dir=None, **kwargs): diff --git a/documentation/test_python/content/content/__init__.py b/documentation/test_python/content/content/__init__.py index e555cf0f..234230c2 100644 --- a/documentation/test_python/content/content/__init__.py +++ b/documentation/test_python/content/content/__init__.py @@ -18,7 +18,7 @@ class Class: """A dunder method""" def method(self): - """This summary will get overriden from the docs""" + """This summary will get overridden from the docs""" def method_with_details(self): pass diff --git a/documentation/test_python/page/another.html b/documentation/test_python/page/another.html index 5501daf9..b100b16e 100644 --- a/documentation/test_python/page/another.html +++ b/documentation/test_python/page/another.html @@ -22,7 +22,7 @@

Another page

-

Here's some summary. It's formated as well.

+

Here's some summary. It's formatted as well.

And the text.

diff --git a/documentation/test_python/page/another.rst b/documentation/test_python/page/another.rst index a6508a09..2d96df5b 100644 --- a/documentation/test_python/page/another.rst +++ b/documentation/test_python/page/another.rst @@ -1,6 +1,6 @@ Another page ############ -:summary: Here's some summary. **It's formated as well.** +:summary: Here's some summary. **It's formatted as well.** And the *text*. diff --git a/documentation/test_python/page/pages.html b/documentation/test_python/page/pages.html index f1633627..958fec2d 100644 --- a/documentation/test_python/page/pages.html +++ b/documentation/test_python/page/pages.html @@ -21,7 +21,7 @@

Pages