aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/api.md
diff options
context:
space:
mode:
authorJakub Wilk <jwilk@jwilk.net>2018-02-17 10:58:49 +0100
committerWaylan Limberg <waylan.limberg@icloud.com>2018-02-17 15:15:56 -0500
commitb0e993a23ab96562d9e0e86fcba715c9d8b9ffcf (patch)
treea03bed6b9f7faece3a7a9c7cb91825b0081d5c90 /docs/extensions/api.md
parent8c0698b013edeb82586290e637df7c30ede81b5a (diff)
downloadmarkdown-b0e993a23ab96562d9e0e86fcba715c9d8b9ffcf.tar.gz
markdown-b0e993a23ab96562d9e0e86fcba715c9d8b9ffcf.tar.bz2
markdown-b0e993a23ab96562d9e0e86fcba715c9d8b9ffcf.zip
Fix typos
Diffstat (limited to 'docs/extensions/api.md')
-rw-r--r--docs/extensions/api.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/extensions/api.md b/docs/extensions/api.md
index ad0d254..a110cef 100644
--- a/docs/extensions/api.md
+++ b/docs/extensions/api.md
@@ -172,7 +172,7 @@ does not appear to be a link, it returns `None` for the start and end boundary
in order to communicate to the parser that no match was found.
```python
- # Just a snippet of of the link's handleMatch
+ # Just a snippet of the link's handleMatch
# method to illustrate new logic
def handleMatch(self, m, data):
text, index, handled = self.getText(data, m.end(0))
@@ -417,7 +417,7 @@ An instance of the **`BlockParser`** is found at `Markdown.parser`.
method will generally only be used internally to recursively parse nested
blocks of text.
-While is is not recommended, an extension could subclass or completely replace
+While it is not recommended, an extension could subclass or completely replace
the `BlockParser`. The new class would have to provide the same public API.
However, be aware that other extensions may expect the core parser provided
and will not work with such a drastically different parser.
@@ -756,7 +756,7 @@ For example:
```python
import markdown
-from path.to.module import MyExtention
+from path.to.module import MyExtension
md = markdown.Markdown(extensions=[MyExtension(option='value')])
```
@@ -788,7 +788,7 @@ After a user installs your extension using the above script, they could then
call the extension using the `myextension` string name like this:
```python
-markdown.markdown(text, extensions=['myextention'])
+markdown.markdown(text, extensions=['myextension'])
```
Note that if two or more entry points within the same group are assigned the
@@ -808,13 +808,13 @@ be at the end of the name and be separated by a colon from the module.
Therefore, if you were to import the class like this:
```python
-from path.to.module import MyExtention
+from path.to.module import MyExtension
```
Then the extension can be loaded as follows:
```python
-markdown.markdown(text, extensions=['path.to.module:MyExtention'])
+markdown.markdown(text, extensions=['path.to.module:MyExtension'])
```
You do not need to do anything special to support this feature. As long as your