Skip to content

Commit a22237a

Browse files
committed
docs: Explicitly list Google-style parser's parameters and document them
1 parent 5e7af22 commit a22237a

1 file changed

Lines changed: 18 additions & 6 deletions

File tree

src/_griffe/docstrings/google.py

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -748,9 +748,11 @@ def parse_google(
748748
ignore_init_summary: bool = False,
749749
trim_doctest_flags: bool = True,
750750
returns_multiple_items: bool = True,
751-
warn_unknown_params: bool = True,
752751
returns_named_value: bool = True,
753752
returns_type_in_property_summary: bool = False,
753+
receives_multiple_items: bool = True,
754+
receives_named_value: bool = True,
755+
warn_unknown_params: bool = True,
754756
**options: Any,
755757
) -> list[DocstringSection]:
756758
"""Parse a Google-style docstring.
@@ -762,13 +764,21 @@ def parse_google(
762764
docstring: The docstring to parse.
763765
ignore_init_summary: Whether to ignore the summary in `__init__` methods' docstrings.
764766
trim_doctest_flags: Whether to remove doctest flags from Python example blocks.
765-
returns_multiple_items: Whether the `Returns` section has multiple items.
766-
warn_unknown_params: Warn about documented parameters not appearing in the signature.
767-
returns_named_value: Whether to parse `thing: Description` in returns sections as a name and description,
768-
rather than a type and description. When true, type must be wrapped in parentheses: `(int): Description.`.
767+
returns_multiple_items: Whether to parse multiple items in `Yields` and `Returns` sections.
768+
When true, each item's continuation lines must be indented.
769+
When false (single item), no further indentation is required.
770+
returns_named_value: Whether to parse `Yields` and `Returns` section items as name and description, rather than type and description.
771+
When true, type must be wrapped in parentheses: `(int): Description.`. Names are optional: `name (int): Description.`.
772+
When false, parentheses are optional but the items cannot be named: `int: Description`.
773+
receives_multiple_items: Whether to parse multiple items in `Receives` sections.
774+
When true, each item's continuation lines must be indented.
775+
When false (single item), no further indentation is required.
776+
receives_named_value: Whether to parse `Receives` section items as name and description, rather than type and description.
777+
When true, type must be wrapped in parentheses: `(int): Description.`. Names are optional: `name (int): Description.`.
769778
When false, parentheses are optional but the items cannot be named: `int: Description`.
770779
returns_type_in_property_summary: Whether to parse the return type of properties
771780
at the beginning of their summary: `str: Summary of the property`.
781+
warn_unknown_params: Warn about documented parameters not appearing in the signature.
772782
**options: Additional parsing options.
773783
774784
Returns:
@@ -784,9 +794,11 @@ def parse_google(
784794
"ignore_init_summary": ignore_init_summary,
785795
"trim_doctest_flags": trim_doctest_flags,
786796
"returns_multiple_items": returns_multiple_items,
787-
"warn_unknown_params": warn_unknown_params,
788797
"returns_named_value": returns_named_value,
789798
"returns_type_in_property_summary": returns_type_in_property_summary,
799+
"receives_multiple_items": receives_multiple_items,
800+
"receives_named_value": receives_named_value,
801+
"warn_unknown_params": warn_unknown_params,
790802
**options,
791803
}
792804

0 commit comments

Comments
 (0)