Skip to content

📚 DOCS: Fix typos #203

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

Merged
merged 2 commits into from
Apr 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ It can be setup by:
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 `markdown-it-py/docstring.fmt.mustache` and can be used automatically with the [autodocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) VS Code extension.
The preferred docstring format is outlined in `markdown-it-py/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 markdown_it/common/html_blocks.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""List of valid html blocks names, accorting to commonmark spec
"""List of valid html blocks names, according to commonmark spec
http://jgm.github.io/CommonMark/spec.html#html-blocks
"""

Expand Down
2 changes: 1 addition & 1 deletion markdown_it/port.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@
`MarkdownIt.add_render_rule(name, function, fmt="html")`,
rather than `MarkdownIt.renderer.rules[name] = function`
and renderers should declare a class property `__output__ = "html"`.
This allows for extensability to more than just HTML renderers
This allows for extensibility to more than just HTML renderers
- inline tokens in tables are assigned a map (this is helpful for propagation to children)
2 changes: 1 addition & 1 deletion markdown_it/presets/default.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def make():
"breaks": False, # Convert '\n' in paragraphs into <br>
"langPrefix": "language-", # CSS language prefix for fenced blocks
# Highlighter function. Should return escaped HTML,
# or '' if the source string is not changed and should be escaped externaly.
# or '' if the source string is not changed and should be escaped externally.
# If result starts with <pre... internal wrapper is skipped.
#
# function (/*str, lang, attrs*/) { return ''; }
Expand Down
2 changes: 1 addition & 1 deletion markdown_it/presets/zero.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def make():
"breaks": False, # Convert '\n' in paragraphs into <br>
"langPrefix": "language-", # CSS language prefix for fenced blocks
# Highlighter function. Should return escaped HTML,
# or '' if the source string is not changed and should be escaped externaly.
# or '' if the source string is not changed and should be escaped externally.
# If result starts with <pre... internal wrapper is skipped.
# function (/*str, lang, attrs*/) { return ''; }
"highlight": None,
Expand Down
2 changes: 1 addition & 1 deletion markdown_it/ruler.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ class Ruler
- enable/disable rules
- add/replace rules
- allow assign rules to additional named chains (in the same)
- cacheing lists of active rules
- caching lists of active rules

You will not need use this class directly until write plugins. For simple
rules control use [[MarkdownIt.disable]], [[MarkdownIt.enable]] and
Expand Down
2 changes: 1 addition & 1 deletion markdown_it/rules_inline/strikethrough.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def _postProcess(state: StateInline, delimiters: list[Delimiter]):

i += 1

# If a marker sequence has an odd number of characters, it's splitted
# If a marker sequence has an odd number of characters, it's split
# like this: `~~~~~` -> `~` + `~~` + `~~`, leaving one marker at the
# start of the sequence.
#
Expand Down
2 changes: 1 addition & 1 deletion markdown_it/rules_inline/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


# Rule to skip pure text
# '{}$%@~+=:' reserved for extentions
# '{}$%@~+=:' reserved for extensions

# !, ", #, $, %, &, ', (, ), *, +, ,, -, ., /, :, ;, <, =, >, ?, @, [, \, ], ^, _, `, {, |, }, or ~

Expand Down
2 changes: 1 addition & 1 deletion tests/test_cmark_spec/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -4533,7 +4533,7 @@ inside the code block:

Note that rules #1 and #2 only apply to two cases: (a) cases
in which the lines to be included in a list item begin with a
characer other than a space or tab, and (b) cases in which
character other than a space or tab, and (b) cases in which
they begin with an indented code
block. In a case like the following, where the first block begins with
three spaces of indentation, the rules do not allow us to form a list item by
Expand Down
2 changes: 1 addition & 1 deletion tests/test_cmark_spec/test_spec/test_file.html
Original file line number Diff line number Diff line change
Expand Up @@ -3418,7 +3418,7 @@ <h2>List items</h2>
</code></pre>
<p>Note that rules #1 and #2 only apply to two cases: (a) cases
in which the lines to be included in a list item begin with a
characer other than a space or tab, and (b) cases in which
character other than a space or tab, and (b) cases in which
they begin with an indented code
block. In a case like the following, where the first block begins with
three spaces of indentation, the rules do not allow us to form a list item by
Expand Down
6 changes: 3 additions & 3 deletions tests/test_port/fixtures/fatal.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
Should not throw exception on invalid chars in URL (`*` not allowed in path) [mailformed URI]
Should not throw exception on invalid chars in URL (`*` not allowed in path) [malformed URI]
.
[foo](<&#x25;test>)
.
<p><a href="%25test">foo</a></p>
.


Should not throw exception on broken utf-8 sequence in URL [mailformed URI]
Should not throw exception on broken utf-8 sequence in URL [malformed URI]
.
[foo](%C3)
.
<p><a href="%C3">foo</a></p>
.


Should not throw exception on broken utf-16 surrogates sequence in URL [mailformed URI]
Should not throw exception on broken utf-16 surrogates sequence in URL [malformed URI]
.
[foo](&#xD800;)
.
Expand Down