Skip to content

Commit d83115d

Browse files
committed
adapt default delim
In mkdocs, a new paragraph will only appear if two newline characters are used, resulting in a completely empty line.
1 parent 7e02118 commit d83115d

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

src/mkdocstrings_handlers/python/handler.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ class PythonHandler(BaseHandler):
113113
"members": None,
114114
"inherited_members": False,
115115
"docstring_inherit_strategy": rendering.DocstringInheritStrategy.default.value,
116-
"docstring_merge_delimiter": "\n",
116+
"docstring_merge_delimiter": "\n\n",
117117
"filters": ["!^_[^_]"],
118118
"annotations_path": "brief",
119119
"preload_modules": None,

src/mkdocstrings_handlers/python/rendering.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ def do_optionally_inherit_docstrings(
425425
objects: dict[str, Object | Alias],
426426
*,
427427
docstring_inherit_strategy: str = DocstringInheritStrategy.default.value,
428-
docstring_merge_delimiter: str = "\n",
428+
docstring_merge_delimiter: str = "\n\n",
429429
) -> dict[str, Object | Alias]:
430430
"""Optionally inherit docstrings for members in the given .
431431

0 commit comments

Comments
 (0)