diff options
| author | Waylan Limberg <waylan.limberg@icloud.com> | 2019-11-25 16:12:00 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-25 16:12:00 -0500 |
| commit | ec7e200d28086e594edee2a6f4569a71c1215d34 (patch) | |
| tree | bfe547967a361ee900f9323a80e7338727e5c2ef | |
| parent | 15cbaef36e7a121db7d41535793ebf98533b2d8e (diff) | |
| download | python-markdown-ec7e200d28086e594edee2a6f4569a71c1215d34.tar.gz | |
Document thread safety (#882)
Fixed #812.
| -rw-r--r-- | .spell-dict | 1 | ||||
| -rw-r--r-- | docs/change_log/release-3.2.md | 3 | ||||
| -rw-r--r-- | docs/reference.md | 8 |
3 files changed, 10 insertions, 2 deletions
diff --git a/.spell-dict b/.spell-dict index 11a6375..7baf984 100644 --- a/.spell-dict +++ b/.spell-dict @@ -126,6 +126,7 @@ Treeprocessor Treeprocessors tuple tuples +unescape unordered untrusted UTF diff --git a/docs/change_log/release-3.2.md b/docs/change_log/release-3.2.md index 5a22fcd..0a69284 100644 --- a/docs/change_log/release-3.2.md +++ b/docs/change_log/release-3.2.md @@ -53,14 +53,15 @@ continue to see the old behavior. The following new features have been included in the release: +* Document thread safety (#812). * Markdown parsing in HTML has been exposed via a separate extension called [`md_in_html`](../extensions/md_in_html.md). - * Add support for Python 3.8. ## Bug fixes The following bug fixes are included in the 3.2 release: +* Unescape backslash-escaped characters in TOC ids (#864). * Refactor bold and italic logic in order to solve complex nesting issues (#792). * Always wrap CodeHilite code in <code> tags (#862). diff --git a/docs/reference.md b/docs/reference.md index f8f2e52..44fd174 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -225,7 +225,13 @@ __encoding__{: #encoding } The same options are available when initializing the `markdown.Markdown` class as on the [`markdown.markdown`](#markdown) function, except that the class does **not** accept a source text string on initialization. Rather, the source text -string must be passed to one of two instance methods: +string must be passed to one of two instance methods. + +!!! warning + + Instances of the `markdown.Markdown` class are only thread safe within + the thread they were created in. A single instance should not be accessed + from multiple threads. #### Markdown.convert(source) {: #convert } |