Skip to content

Commit cfa5c7e

Browse files
committed
docs: Link to docstring options in Griffe docs
1 parent 939405e commit cfa5c7e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/griffe2md/_internal/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class ConfigDict(TypedDict, total=False):
6262
"""The verbosity for annotations path: `brief` (recommended), `source` (as written in the source), or `full`."""
6363

6464
docstring_options: DocstringOptions
65-
"""mkdocstring [configuration](https://mkdocstrings.github.io/python/usage/configuration/general/)"""
65+
"""Docstring options understood by Griffe. See [docstring parsers](https://mkdocstrings.github.io/griffe/reference/docstrings/)."""
6666

6767
docstring_section_style: Literal["list", "table"]
6868
"""The style used to render docstring sections."""

0 commit comments

Comments
 (0)