Skip to content

Commit 9c3ac65

Browse files
committed
refactor: rename python_markdown to pymd for consistency
1 parent 157750e commit 9c3ac65

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

mdformat_mkdocs/mdit_plugins/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
mkdocstrings_crossreference_plugin,
1616
)
1717
from ._pymd_abbreviations import PYMD_ABBREVIATIONS_PREFIX, pymd_abbreviations_plugin
18+
from ._pymd_admon import pymd_admon_plugin
1819
from ._pymd_snippet import PYMD_SNIPPET_PREFIX, pymd_snippet_plugin
19-
from ._python_markdown_admon import python_markdown_admon_plugin
2020

2121
__all__ = (
2222
"MATERIAL_ADMON_MARKERS",
@@ -31,6 +31,6 @@
3131
"mkdocstrings_autorefs_plugin",
3232
"mkdocstrings_crossreference_plugin",
3333
"pymd_abbreviations_plugin",
34+
"pymd_admon_plugin",
3435
"pymd_snippet_plugin",
35-
"python_markdown_admon_plugin",
3636
)

mdformat_mkdocs/mdit_plugins/_material_admon.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
parse_tag_and_title,
2929
)
3030

31-
from ._python_markdown_admon import format_python_markdown_admon_markup
31+
from ._pymd_admon import format_pymd_admon_markup
3232

3333
MATERIAL_ADMON_PREFIX = "admonition_mkdocs"
3434
"""Prefix used to differentiate the parsed output."""
@@ -44,7 +44,7 @@ def format_admon_markup(
4444
) -> None:
4545
"""Format markup."""
4646
if admonition.marker == "!!!":
47-
format_python_markdown_admon_markup(state, start_line, admonition)
47+
format_pymd_admon_markup(state, start_line, admonition)
4848
return
4949

5050
tags, title = parse_tag_and_title(admonition.meta_text)

mdformat_mkdocs/mdit_plugins/_python_markdown_admon.py renamed to mdformat_mkdocs/mdit_plugins/_pymd_admon.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"""Prefix used to differentiate the parsed output."""
1919

2020

21-
def format_python_markdown_admon_markup(
21+
def format_pymd_admon_markup(
2222
state: StateBlock,
2323
start_line: int,
2424
admonition: AdmonitionData,
@@ -77,9 +77,9 @@ def admonition_logic(
7777
)
7878
result = parse_possible_whitespace_admon(state, start_line, end_line, silent)
7979
if isinstance(result, AdmonitionData):
80-
format_python_markdown_admon_markup(state, start_line, admonition=result)
80+
format_pymd_admon_markup(state, start_line, admonition=result)
8181
return True
8282
return result
8383

8484

85-
python_markdown_admon_plugin = admon_plugin_factory(PREFIX, admonition_logic)
85+
pymd_admon_plugin = admon_plugin_factory(PREFIX, admonition_logic)

mdformat_mkdocs/plugin.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
mkdocstrings_autorefs_plugin,
2626
mkdocstrings_crossreference_plugin,
2727
pymd_abbreviations_plugin,
28+
pymd_admon_plugin,
2829
pymd_snippet_plugin,
29-
python_markdown_admon_plugin,
3030
)
3131

3232
ContextOptions = Mapping[str, Any]
@@ -72,7 +72,7 @@ def update_mdit(mdit: MarkdownIt) -> None:
7272
mdit.use(mkdocstrings_autorefs_plugin)
7373
mdit.use(pymd_abbreviations_plugin)
7474
mdit.use(pymd_snippet_plugin)
75-
mdit.use(python_markdown_admon_plugin) # FIXME: standardize pymd name
75+
mdit.use(pymd_admon_plugin)
7676

7777
if cli_is_ignore_missing_references(mdit.options):
7878
mdit.use(mkdocstrings_crossreference_plugin)

0 commit comments

Comments
 (0)