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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摎 DOCS: Fix typos #535

Merged
merged 1 commit into from
Mar 12, 2022
Merged
Show file tree
Hide file tree
Changes from all 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 CHANGELOG.md
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/api/parsers.md
Expand Up @@ -247,7 +247,7 @@ Here's some *text*
```
<!-- #endregion -->

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:
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/contributing.md
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/syntax/syntax.md
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion myst_parser/mathjax.py
Expand Up @@ -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 = (
Expand Down
2 changes: 1 addition & 1 deletion myst_parser/myst_refs.py
Expand Up @@ -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
)
Expand Down
2 changes: 1 addition & 1 deletion 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.

Expand Down
2 changes: 1 addition & 1 deletion tests/test_sphinx/sourcedirs/substitutions/index.md
Expand Up @@ -16,7 +16,7 @@ substitutions:
```{note}
Inline note
```
override: Overriden by front matter
override: Overridden by front matter

---

Expand Down
Expand Up @@ -46,7 +46,7 @@
This was from the conf
</p>
<p>
Overriden by front matter
Overridden by front matter
</p>
<p>
This will process the substitution
Expand Down
Expand Up @@ -33,7 +33,7 @@
<paragraph>
This was from the conf
<paragraph>
Overriden by front matter
Overridden by front matter
<paragraph>
This will process the substitution
<literal_block xml:space="preserve">
Expand Down