Skip to content

Commit fc19c49

Browse files
fix: renderer="ast" same as render=None (#351)
1 parent d65a097 commit fc19c49

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

Diff for: docs/upgrade.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ When customizing renderers, these methods' parameters are changed:
3333
AstRenderer
3434
~~~~~~~~~~~
3535

36-
There is no ``AstRenderer`` in v3, just pass ``None`` to ``create_markdown``::
36+
There is no ``AstRenderer`` in v3, just pass ``None`` or ``'ast'`` to ``create_markdown``::
3737

3838
import mistune
3939

40-
md = mistune.create_markdown(renderer=None)
40+
md = mistune.create_markdown(renderer='ast') # or render=None
4141
md('...markdown text...')
4242

4343
Plugins

Diff for: src/mistune/__init__.py

+7-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ def create_markdown(escape: bool=True, hard_wrap: bool=False, renderer='html', p
3434
# re-use markdown function
3535
markdown('.... your text ...')
3636
"""
37-
if renderer == 'html':
37+
if renderer == 'ast':
38+
# explicit and more similar to 2.x's API
39+
renderer = None
40+
elif renderer == 'html':
3841
renderer = HTMLRenderer(escape=escape)
3942

4043
inline = InlineParser(hard_wrap=hard_wrap)
@@ -53,6 +56,9 @@ def create_markdown(escape: bool=True, hard_wrap: bool=False, renderer='html', p
5356

5457

5558
def markdown(text, escape=True, renderer='html', plugins=None) -> str:
59+
if renderer == 'ast':
60+
# explicit and more similar to 2.x's API
61+
renderer = None
5662
key = (escape, renderer, plugins)
5763
if key in __cached_parsers:
5864
return __cached_parsers[key](text)

0 commit comments

Comments
 (0)