From a5f2723337f00c269d808d552f5c496842ce2eb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Sun, 28 Apr 2024 17:16:41 +0200 Subject: [PATCH] docs: Document handler's `update_env` method --- src/mkdocstrings_handlers/python/handler.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/mkdocstrings_handlers/python/handler.py b/src/mkdocstrings_handlers/python/handler.py index 1e98b76..a473f92 100644 --- a/src/mkdocstrings_handlers/python/handler.py +++ b/src/mkdocstrings_handlers/python/handler.py @@ -398,7 +398,13 @@ def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str: # noqa }, ) - def update_env(self, md: Markdown, config: dict) -> None: # noqa: D102 (ignore missing docstring) + def update_env(self, md: Markdown, config: dict) -> None: + """Update the Jinja environment with custom filters and tests. + + Parameters: + md: The Markdown instance. + config: The configuration dictionary. + """ super().update_env(md, config) self.env.trim_blocks = True self.env.lstrip_blocks = True