Skip to content

Commit 9a25e1e

Browse files
committed
Add docu in Docstrings options
1 parent 9585ab5 commit 9a25e1e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/mkdocstrings_handlers/python/handler.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,8 @@ class PythonHandler(BaseHandler):
181181
merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`.
182182
relative_crossrefs (bool): Whether to enable the relative crossref syntax. Default: `False`.
183183
scoped_crossrefs (bool): Whether to enable the scoped crossref ability. Default: `False`.
184+
docstring_inherit_strategy (str): The strategy to inherit docstrings of members from their implementation in parent classes. Options: `default`, `if_not_present`, `merge`. Default: `"default"`.
185+
docstring_merge_delimiter (str): The delimiter used to merge docstrings, only applies when `docstring_inherit_strategy` is set to `merge`. Default: `"\n\n"`.
184186
show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.
185187
show_docstring_attributes (bool): Whether to display the "Attributes" section in the object's docstring. Default: `True`.
186188
show_docstring_functions (bool): Whether to display the "Functions" or "Methods" sections in the object's docstring. Default: `True`.

0 commit comments

Comments
 (0)