Skip to content

Commit

Permalink
Typos: remove various duplicated words
Browse files Browse the repository at this point in the history
  • Loading branch information
facelessuser committed Sep 30, 2024
1 parent d43141d commit 3f6fbbb
Show file tree
Hide file tree
Showing 17 changed files with 43 additions and 44 deletions.
2 changes: 1 addition & 1 deletion docs/src/markdown/about/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,7 @@ Please see [Migration Notes](./releases/6.0.md#6.0) for details on upgrading to
- **NEW**: Arithmatex now has configurable output wrapper.
- **NEW**: PathConverter no longer verifies existence of path to allow it more flexible usage.
- **NEW**: PathConverter now only converts relative paths when converting to a relative or absolute location.
- **NEW**: Improved support for path path identification for PathConverter and B64.
- **NEW**: Improved support for path identification for PathConverter and B64.
- **FIX**: Fixed issue where Arithmatex was un-escaping `$` within math region.
- **FIX**: Fixed issue where plugins would append globally changing the escape list opposed to just in the in the
Markdown instance.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/markdown/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ they are asking about. Feel free to share your experience to help others out.

## Pull Requests :octicons-git-pull-request-24:

Pull requests are welcome, and a great way to help fix bugs and add new features. If you you are interested in directly
Pull requests are welcome, and a great way to help fix bugs and add new features. If you are interested in directly
contributing to the code, please check out [Development](./development.md) for more info on the environment and process.

## Documentation Improvements :material-pencil:
Expand Down
8 changes: 4 additions & 4 deletions docs/src/markdown/about/releases/7.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ implement this behavior with your own custom formatter.

Additional classes and IDs can now be injected into fenced code blocks with the format ` ```{.lang .more-class} `.

The attribute list feature also impacts the the custom formatter. While the default formatters will still inject
classes and IDs to the top level element to preserve backwards compatibility, the formatter now must accept the new
keyword parameters `classes` and `id_value`. If you have a custom formatter that does not adhere to this new
requirement, you will see a user warning.
The attribute list feature also impacts the custom formatter. While the default formatters will still inject classes and
IDs to the top level element to preserve backwards compatibility, the formatter now must accept the new keyword
parameters `classes` and `id_value`. If you have a custom formatter that does not adhere to this new requirement, you
will see a user warning.

The new format is:

Expand Down
6 changes: 3 additions & 3 deletions docs/src/markdown/about/releases/8.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ In general, there are a couple things to be aware of when upgrading to 8.0.
## Better Support for JS Highlighters

- SuperFences adds the ability, when using the brace header format (` ```{.lang .class #id attr=value} `) to add
arbitrary HTML attributes to code blocks. By default, all classes, IDs and and attributes are added to the `code`
block of the generated output. The one exception is that the default `highlight` class is always added to the top
level element.
arbitrary HTML attributes to code blocks. By default, all classes, IDs and attributes are added to the `code` block
of the generated output. The one exception is that the default `highlight` class is always added to the top level
element.

For instance, if a user needed to specify that a line number starts with an attribute `data-linenum-start`, they
could simply use the brace header format to define this new attribute:
Expand Down
4 changes: 2 additions & 2 deletions docs/src/markdown/extensions/arithmatex.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ HTML output. This is because `#!tex $...$` is extremely problematic to scan for,
disable `#!tex $...$` by default in their plain text scanners, and why Arithmatex enables `smart_dollar` by default
when scanning for `#!tex $...$`.

It is advised that if you are outputting in in `generic` mode that you do not configure your JavaScript library to
look for `#!tex $...$` and instead look for `#!tex \(...\)`, and let Arithmatex's handle `#!tex $...$`.
It is advised that if you are outputting in `generic` mode that you do not configure your JavaScript library to look for
`#!tex $...$` and instead look for `#!tex \(...\)`, and let Arithmatex's handle `#!tex $...$`.
///

For block forms, the block must start with the appropriate opening for the block type: `#!tex $$`, `#!tex \[`, and
Expand Down
8 changes: 4 additions & 4 deletions docs/src/markdown/extensions/blocks/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Markdown content.
## Block Extension Anatomy

Normally with Python Markdown, you'd create a processor derived from the various processor types available in the
library. You'd then derive an extension from `markdown.Extension` that would register the the processor. Block
extensions are very similar.
library. You'd then derive an extension from `markdown.Extension` that would register the processor. Block extensions
are very similar.

A Block extension is comprised of two parts: the `Block` object and the `BlocksExtension`. It should be noted that we do
not use `markdown.Extension`, but `BlocksExtension` which is derived from it. This is done so we can abstract away the
Expand Down Expand Up @@ -171,7 +171,7 @@ class MyBlock(Block):
`attrs` takes a dictionary of `str` keys and `str` values describing the attributes to apply to the outer element of
the block as returned by the [`on_create`](#on_create-event).

The `attrs` input input is sent through [`type_html_attribute_dict`](#type_html_attribute_dict) and is accessible to
The `attrs` input is sent through [`type_html_attribute_dict`](#type_html_attribute_dict) and is accessible to
developers via `self.options['attrs']`. The result is a dictionary of key/value pairs where the key is a `#!py3 str` and
the value is a `#!py3 str` (or `#!py3 list[str]` in the special case of `class`).
///
Expand Down Expand Up @@ -222,7 +222,7 @@ execute. Each block in a document that is encountered generates its own, new ins
Only the global `config` is available at this time via `self.config`. The `Markdown` object is also available via
`self.md`.

The can be a good way to perform setup based on on global or local options.
The can be a good way to perform setup based on global or local options.

## `on_validate` Event

Expand Down
4 changes: 2 additions & 2 deletions docs/src/markdown/extensions/blocks/plugins/admonition.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ Some content
////
///

If desired, you can attach a class to an admonition using the the option `type`. If type is set, a class with that name
will be added, and if there is no title, the class name will be used as the title: `note` -> `Note`.
If desired, you can attach a class to an admonition using the option `type`. If type is set, a class with that name will
be added, and if there is no title, the class name will be used as the title: `note` -> `Note`.

```text title="Admonition"
/// admonition | Some title
Expand Down
2 changes: 1 addition & 1 deletion docs/src/markdown/extensions/details.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ support. There are more elaborate polyfills available that support jQuery, add k
IE8. Feel free to modify what is here or find a solution that fits your needs.

/// settings | Basic Polyfill Setup
Here is the basic CSS that that can be used. It is meant to provide a consistent CSS in both browsers that support
Here is the basic CSS that can be used. It is meant to provide a consistent CSS in both browsers that support
`#!html <details><summary>` tags and those that do not.

//// collapse-code
Expand Down
15 changes: 7 additions & 8 deletions docs/src/markdown/extensions/emoji.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,9 +291,8 @@ pymdownx.emoji.to_png_sprite
```

This generator was written to support PNG sprite output for EmojiOne. It is expected that this will be used in
conjunction with the the official EmojiOne CSS. You can include the CSS from the CDN in your document. The CSS
comes in three sizes: 32, 64, 128. Make sure to set the correct size in the options to generate the appropriate
classes.
conjunction with the official EmojiOne CSS. You can include the CSS from the CDN in your document. The CSS comes in
three sizes: 32, 64, 128. Make sure to set the correct size in the options to generate the appropriate classes.

Example CDN for the 2.2.7 version with 64px PNGs:
`https://cdnjs.cloudflare.com/ajax/libs/emojione/2.2.7/assets/sprites/emojione.sprites.css`.
Expand All @@ -320,9 +319,9 @@ pymdownx.emoji.to_svg_sprite
```

This was written to support EmojiOne SVG sprite output. The output form was taken directly from an example in the
EmojiOne source. It is expected that the the user will provide a local version of the official SVG sprite and the
path to it. Unfortunately there is no free 3.0 SVG sprite, so you will need to [download][emojione-sprites-svg] the
old 2.27 one. The output is:
EmojiOne source. It is expected that the user will provide a local version of the official SVG sprite and the path to
it. Unfortunately there is no free 3.0 SVG sprite, so you will need to [download][emojione-sprites-svg] the old 2.27
one. The output is:

```html
<svg class="emojione"><description>😄</description><use xlink:href="./../assets/sprites/emojione.sprites.svg#emoji-1f604"></use></svg>
Expand Down Expand Up @@ -360,7 +359,7 @@ def emoji_index(options, md)

In order to provide a custom index, the Emoji extension must be given a function that returns a suitable emoji index.
The function should simply return the custom index. It accepts both an options dictionary and the markdown object. The
options dictionary is the same object that is specified in in the extensions [settings](#options).
options dictionary is the same object that is specified in the extensions [settings](#options).

The index should be returned in the following format:

Expand Down Expand Up @@ -451,7 +450,7 @@ def emoji_generator(index, shortname, alias, uc, alt, title, category, options,
```

Each different kind of output is controlled by a different emoji generator function, but all generator functions have
the same input format. The options object is the same object that is specified in in the extensions [settings](#options)
the same input format. The options object is the same object that is specified in the extensions [settings](#options)
and is shared with the index as well.

Parameter | Type |Description
Expand Down
4 changes: 2 additions & 2 deletions docs/src/markdown/extensions/fancylists.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,8 @@ specified below.
If you've been paying attention, you may have noticed that when alphabetical lists and Roman numeral lists are **both**
enabled, there arises some ambiguous cases. Currently if `I` occurs in the middle of an alphabetical list, it is assumed
to be an alphabetical list item, but if it starts a list, it is assumed to be a Roman numeral list item. The reverse is
is true for `M`, `D`, `C`, `L`, `X`, and `V` where it is assumed that these are Roman numeral list items if they occur
in the middle of a Roman numeral list, but are assumed to be alphabetical list items if they start a list.
true for `M`, `D`, `C`, `L`, `X`, and `V` where it is assumed that these are Roman numeral list items if they occur in
the middle of a Roman numeral list, but are assumed to be alphabetical list items if they start a list.

/// note
It should be noted that these issues exists in pretty much all implementations that support this way of including both
Expand Down
2 changes: 1 addition & 1 deletion docs/src/markdown/extensions/inlinehilite.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def format_fail(src, language, class_name, md):
raise InlineHiliteException('Fail!')
```

`InlineHiliteException` can be used to to raise other exceptions if desired.
`InlineHiliteException` can be used to raise other exceptions if desired.


```py
Expand Down
4 changes: 2 additions & 2 deletions docs/src/markdown/extensions/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ maps some aliases to entries in the key-map index.

If you want to add additional keys, or override text of existing keys, you can feed in your keys via the `key_map`
option. The `key_map` parameter takes a simple dictionary with *key names* that are represented by lowercase
alphanumeric characters and hyphens (`-`). The values of the dictionary represent the the text that is displayed for the
key in the HTML output.
alphanumeric characters and hyphens (`-`). The values of the dictionary represent the text that is displayed for the key
in the HTML output.

So if you wanted to add a custom key, you could do this: `#!py3 {"custom": "Custom Key"}`. If you wanted to override
the output of the `option` key and change it from `Option` to `Opt`, you could do this: `#!py3 {"option": "Opt"}`.
Expand Down
6 changes: 3 additions & 3 deletions docs/src/markdown/extensions/magiclink.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ email links. It can auto-convert repository links (GitHub, GitLab, and Bitbucket
shorthand format. MagicLink can also be configured to directly auto-link the aforementioned shorthand format.

If you happen to have some conflicts with syntax for a specific case, you can always revert to the old auto-link format
as well: `#!md <https://www.link.com>`. If enabled, repository link shortening will be applied to the the angle
bracketed auto-link format as well.
as well: `#!md <https://www.link.com>`. If enabled, repository link shortening will be applied to the angle bracketed
auto-link format as well.

/// tip | SaneHeaders
It is also recommended to use [SaneHeaders](./saneheaders.md) when using MagicLink to avoid problems when specifying
Expand Down Expand Up @@ -204,7 +204,7 @@ The syntax was borrowed and adapted from GitLab as they use `!{num}` for pulls a
own take for discussions. This syntax was
mainly used to ensure we could provide context to the link generator. When rendering the actual links in your documents,
it will use the syntax associated with the specified provider. If this is unsatisfactory, you can override this behavior
with the `icons` option and all links will will use the same specified convention on output regardless of the provider.
with the `icons` option and all links will use the same specified convention on output regardless of the provider.

```text title="Issues"
#1
Expand Down
2 changes: 1 addition & 1 deletion docs/src/markdown/extensions/saneheaders.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Currently, Pymdown Extensions has two extensions where SaneHeaders can help.
represent issue links. There may be extensions that use names after hashes to provide tags (`#tag`). With
SaneHeaders, these syntaxes can coexist. Those familiar with CommonMark may recognize this behavior.

2. [FancyLists' syntax](./fancylists.md) exposes a a generic ordered list style that doesn't require you to provide
2. [FancyLists' syntax](./fancylists.md) exposes a generic ordered list style that doesn't require you to provide
numbers. This syntax utilize the `#.` marker for list items.

```py3
Expand Down
4 changes: 2 additions & 2 deletions docs/src/markdown/extensions/snippets.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ filename.md
filename.log
;--8<--
```
The block format differs from the single format by requiring the the content to be fenced between two `--8<--`. The
start and end `--8<--` must be on a line by themselves.
The block format differs from the single format by requiring the content to be fenced between two `--8<--`. The start
and end `--8<--` must be on a line by themselves.

When using the block format empty lines are also preserved within the block. Consider the example below.

Expand Down
10 changes: 5 additions & 5 deletions docs/src/markdown/extensions/superfences.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ Line numbers are provided via Pygments and can either be shown per code block or
[`pymdownx.highlight`](./highlight.md), you must set `linenums` to `#!py3 True` in the respective extension.

To set line numbers per code block, you can specify a special setting directly after the opening tokens (and language if
present). Simply specify the starting line line number with option `linenums="1"`. The setting is followed by the equal
present). Simply specify the starting line number with option `linenums="1"`. The setting is followed by the equal
sign and the value must be quoted. Valid line numbers are n > 0. If `linenums` is enabled globally, this will just
control the starting line shown in the block.

Expand Down Expand Up @@ -430,7 +430,7 @@ import foo.bar.baz

If the `auto_title` option is enabled in the [Highlight extension](./highlight.md), the title will be auto populated
with the name of the lexer used to highlight the code (unless `title` is manually specified). In the example below,
no `title` is specified, but the the title is extracted from the Python lexer.
no `title` is specified, but the title is extracted from the Python lexer.

````text title="Automatic Titles"
```python
Expand Down Expand Up @@ -570,8 +570,8 @@ import foo
```
///

We can also wrap line numbers with with a link and inject anchors so you can click line numbers and be taken to said
line. To do this, `anchor_linenums` must be enabled and then a prefix should be provided via `line_anchors`, just like
We can also wrap line numbers with a link and inject anchors so you can click line numbers and be taken to said line. To
do this, `anchor_linenums` must be enabled and then a prefix should be provided via `line_anchors`, just like
`line_spans`, `line_anchors` will produce an ID in the form `prefix-x-y` where `x` is a unique number for the code block
and `y` is the line number. If you wish to not have the line numbers clickable, and just have the anchors inserted,
you can omit enabling `anchor_linenums`.
Expand Down Expand Up @@ -801,7 +801,7 @@ not go back to validate the use of a different formatter.

Some users may want such failures to not silently go by. SuperFences exposes a special exception called
`SuperFencesException` which, if raised, will not gracefully be handled. If `SuperFencesException` is raised, this will
likely bubble all the way up and cause Markdown parsing to halt. `SuperFencesException` can be used to to raise other
likely bubble all the way up and cause Markdown parsing to halt. `SuperFencesException` can be used to raise other
exceptions if desired.

Here we have a contrived example. When no options are provided in this validator, we will try and access a non-existent
Expand Down
4 changes: 2 additions & 2 deletions docs/src/markdown/extras/mermaid.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ in the best way possible. To be honest, Mermaid is a little buggy and required s
quirks.

In general, we leave setting up custom fences for the user to explore, but we do get asked occasionally how to get
Mermaid working, and what we are doing, so we thought we'd share some some additional information in case there is a
strong desire from any of our users to implement a robust Mermaid solution.
Mermaid working, and what we are doing, so we thought we'd share some additional information in case there is a strong
desire from any of our users to implement a robust Mermaid solution.

If you'd like to see exactly what we do, you can checkout our source code, but in this example, we will show the basics.

Expand Down

0 comments on commit 3f6fbbb

Please sign in to comment.