diff options
author | Maurice van der Pot <griffon26@kfk4ever.com> | 2018-11-18 15:12:44 +0100 |
---|---|---|
committer | Waylan Limberg <waylan.limberg@icloud.com> | 2018-11-18 09:12:44 -0500 |
commit | e8e5a087ef9185aaf5d25ccfc9a18f06eac4e097 (patch) | |
tree | 41b8739adc51d7f3f6556b8844192da24a45f77f | |
parent | d41adf5e37b7c04cddc524045b02eb47f4a1dbdd (diff) | |
download | python-markdown-e8e5a087ef9185aaf5d25ccfc9a18f06eac4e097.tar.gz |
Clarify in docs that a high value corresponds to high extension priority (#756)
This fixes #755
-rw-r--r-- | docs/extensions/api.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/extensions/api.md b/docs/extensions/api.md index c236a93..25a536d 100644 --- a/docs/extensions/api.md +++ b/docs/extensions/api.md @@ -564,8 +564,9 @@ registry: `register` and `deregister`. Use `register` to add items and `deregister` to remove items. See each method for specifics. When registering an item, a "name" and a "priority" must be provided. All -items are automatically sorted by "priority" from highest to lowest. The -"name" is used to remove (`deregister`) and get items. +items are automatically sorted by the value of the "priority" parameter such +that the item with the highest value will be processed first. The "name" is +used to remove (`deregister`) and get items. A `Registry` instance is like a list (which maintains order) when reading data. You may iterate over the items, get an item and get a count (length) |