Skip to content

Commit

Permalink
docs: Document handler's update_env method
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Apr 28, 2024
1 parent a71ab12 commit a5f2723
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/mkdocstrings_handlers/python/handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a5f2723

Please sign in to comment.