From dc45a1f1f47b6b39abbb26ae2d1b50723cd06e6b Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Sat, 12 Mar 2022 17:25:13 +0800 Subject: [PATCH] DOCS: Fix typos (#535) --- CHANGELOG.md | 2 +- docs/api/parsers.md | 2 +- docs/develop/contributing.md | 2 +- docs/syntax/syntax.md | 2 +- myst_parser/mathjax.py | 2 +- myst_parser/myst_refs.py | 2 +- myst_parser/parse_html.py | 2 +- tests/test_sphinx/sourcedirs/substitutions/index.md | 2 +- tests/test_sphinx/test_sphinx_builds/test_substitutions.html | 2 +- tests/test_sphinx/test_sphinx_builds/test_substitutions.xml | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b0173208..0afd95cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -79,7 +79,7 @@ See [Front matter](docs/syntax/syntax.md#front-matter) for more information. Headings within directives are not directly supported by sphinx, since they break the structure of the document. Previously myst-parser would emit a `myst.nested_header` warning, but still generate the heading, leading to unexpected outcomes. Now the warning is still emitted, but also the heading is rendered as a [rubric](https://docutils.sourceforge.io/docs/ref/rst/directives.html#rubric) non-structural heading (i.e. it will not show in the ToC). -Other internal improvements primarily focussed in improving support for the for "docutils-only" use, introduced in `v0.16`: +Other internal improvements primarily focused in improving support for the for "docutils-only" use, introduced in `v0.16`: - ♻️ REFACTOR: `default_parser` -> `create_md_parser` in [#474](https://github.com/executablebooks/MyST-Parser/pull/474) - 👌 IMPROVE: Add `bullet` attribute to `bullet_list` node in [#465](https://github.com/executablebooks/MyST-Parser/pull/465) diff --git a/docs/api/parsers.md b/docs/api/parsers.md index f9e66cc2..b675db2c 100644 --- a/docs/api/parsers.md +++ b/docs/api/parsers.md @@ -247,7 +247,7 @@ Here's some *text* ``` -Note that these tokens are **flat**, although some of the tokens refere to one another (for example, Tokens with `_open` and `_close` represent the start/end of blocks). +Note that these tokens are **flat**, although some of the tokens refer to one another (for example, Tokens with `_open` and `_close` represent the start/end of blocks). Tokens of type `inline` will have a `children` attribute that contains a list of the Tokens that they contain. For example: diff --git a/docs/develop/contributing.md b/docs/develop/contributing.md index 32d60dbe..756e6a93 100644 --- a/docs/develop/contributing.md +++ b/docs/develop/contributing.md @@ -44,7 +44,7 @@ Optionally you can run `black` and `flake8` separately: Editors like VS Code also have automatic code reformat utilities, which can adhere to this standard. -All functions and class methods should be annotated with types and include a docstring. The prefered docstring format is outlined in `MyST-Parser/docstring.fmt.mustache` and can be used automatically with the +All functions and class methods should be annotated with types and include a docstring. The preferred docstring format is outlined in `MyST-Parser/docstring.fmt.mustache` and can be used automatically with the [autodocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) VS Code extension. ## Testing diff --git a/docs/syntax/syntax.md b/docs/syntax/syntax.md index b4065f4f..38436191 100644 --- a/docs/syntax/syntax.md +++ b/docs/syntax/syntax.md @@ -750,7 +750,7 @@ See the [extended image syntax guide](syntax/images). ## Footnotes Footnotes use the [pandoc specification](https://pandoc.org/MANUAL.html#footnotes). -Their labels **start with `^`** and can then be any alpha-numeric string (no spaces), which is case-insensitive. +Their labels **start with `^`** and can then be any alphanumeric string (no spaces), which is case-insensitive. - If the label is an integer, then it will always use that integer for the rendered label (i.e. they are manually numbered). - For any other labels, they will be auto-numbered in the order which they are referenced, skipping any manually numbered labels. diff --git a/myst_parser/mathjax.py b/myst_parser/mathjax.py index c108434f..e430c3ba 100644 --- a/myst_parser/mathjax.py +++ b/myst_parser/mathjax.py @@ -20,7 +20,7 @@ def log_override_warning(app: Sphinx, version: int, current: str, new: str) -> None: - """Log a warning if MathJax configuration being overriden.""" + """Log a warning if MathJax configuration being overridden.""" if logging.is_suppressed_warning("myst", "mathjax", app.config.suppress_warnings): return config_name = ( diff --git a/myst_parser/myst_refs.py b/myst_parser/myst_refs.py index d4deff15..e7847957 100644 --- a/myst_parser/myst_refs.py +++ b/myst_parser/myst_refs.py @@ -72,7 +72,7 @@ def run(self, **kwargs: Any) -> None: if newnode is None: node["refdomain"] = "" # TODO ideally we would override the warning message here, - # to show the [ref.myst] for supressing warning + # to show the [ref.myst] for suppressing warning self.warn_missing_reference( refdoc, node["reftype"], target, node, domain ) diff --git a/myst_parser/parse_html.py b/myst_parser/parse_html.py index 1922aaf3..ccc30bd4 100644 --- a/myst_parser/parse_html.py +++ b/myst_parser/parse_html.py @@ -1,4 +1,4 @@ -"""A simple but complete HTML to Abstact Syntax Tree (AST) parser. +"""A simple but complete HTML to Abstract Syntax Tree (AST) parser. The AST can also reproduce the HTML text. diff --git a/tests/test_sphinx/sourcedirs/substitutions/index.md b/tests/test_sphinx/sourcedirs/substitutions/index.md index 2fc9612a..5c8aa727 100644 --- a/tests/test_sphinx/sourcedirs/substitutions/index.md +++ b/tests/test_sphinx/sourcedirs/substitutions/index.md @@ -16,7 +16,7 @@ substitutions: ```{note} Inline note ``` - override: Overriden by front matter + override: Overridden by front matter --- diff --git a/tests/test_sphinx/test_sphinx_builds/test_substitutions.html b/tests/test_sphinx/test_sphinx_builds/test_substitutions.html index 5b2a7255..c5b3f43f 100644 --- a/tests/test_sphinx/test_sphinx_builds/test_substitutions.html +++ b/tests/test_sphinx/test_sphinx_builds/test_substitutions.html @@ -46,7 +46,7 @@ This was from the conf

- Overriden by front matter + Overridden by front matter

This will process the substitution diff --git a/tests/test_sphinx/test_sphinx_builds/test_substitutions.xml b/tests/test_sphinx/test_sphinx_builds/test_substitutions.xml index 83947444..9a63ee23 100644 --- a/tests/test_sphinx/test_sphinx_builds/test_substitutions.xml +++ b/tests/test_sphinx/test_sphinx_builds/test_substitutions.xml @@ -33,7 +33,7 @@ This was from the conf - Overriden by front matter + Overridden by front matter This will process the substitution