8000 docs: Document handler's `update_env` method · melissawm/mkdocstrings-python@a5f2723 · GitHub
[go: up one dir, main page]

Skip to content

Commit a5f2723

Browse files
committed
docs: Document handler's update_env method
1 parent a71ab12 commit a5f2723

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/mkdocstrings_handlers/python/handler.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,13 @@ def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str: # noqa
398398
},
399399
)
400400

401-
def update_env(self, md: Markdown, config: dict) -> None: # noqa: D102 (ignore missing docstring)
401+
def update_env(self, md: Markdown, config: dict) -> None:
402+
"""Update the Jinja environment with custom filters and tests.
403+
404+
Parameters:
405+
md: The Markdown instance.
406+
config: The configuration dictionary.
407+
"""
402408
super().update_env(md, config)
403409
self.env.trim_blocks = True
404410
self.env.lstrip_blocks = True

0 commit comments

Comments
 (0)
0