Skip to content

🔧 Clarify that add_render_rule's name must match a token type #432

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.

Sign up for GitHub

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
chrisjsewell merged 2 commits into from
Sep 17, 2026
+5 −0
Merged

🔧 Clarify that add_render_rule's name must match a token type #432

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06da43a
Clarify that add_render_rule's name must match a token type
hikmetba-bit Sep 16, 2026
b6b0306
Merge branch 'master' into docs/clarify-add-render-rule-name-308
chrisjsewell Sep 17, 2026
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
5 changes: 5 additions & 0 deletions markdown_it/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,11 @@ def add_render_rule(
"""Add a rule for rendering a particular Token type.

Only applied when ``renderer.__output__ == fmt``

:param name: must equal the ``type`` of the token(s) this should render
(e.g. ``"heading_open"``, ``"fence"``); it is not an arbitrary label.
If it does not match any token type actually produced by the active
rules, ``function`` will silently never be called.
"""
if self.renderer.__output__ == fmt:
self.renderer.rules[name] = function.__get__(self.renderer) # type: ignore
Expand Down
Loading