Skip to content

Commit 6d5e21b

Browse files
[BUG] fix docstring style for the API
#### Metadata * Reference Issue: Fixes #1548 #### Details Our docstrings are written in NumPy docstring style, however in `mkdocs.yml` we used `docstring_style: google` which led to having a wall of text for the parameter sections in the API ref in the documentation.
1 parent 5a840c8 commit 6d5e21b

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

mkdocs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,6 @@ plugins:
127127
docstring_options:
128128
ignore_init_summary: true
129129
trim_doctest_flags: true
130-
returns_multiple_items: false
131130
show_docstring_attributes: true
132131
show_docstring_description: true
133132
show_root_heading: true
@@ -138,7 +137,7 @@ plugins:
138137
merge_init_into_class: true
139138
show_symbol_type_heading: true
140139
show_symbol_type_toc: true
141-
docstring_style: google
140+
docstring_style: numpy
142141
inherited_members: true
143142
show_if_no_docstring: false
144143
show_bases: true

0 commit comments

Comments
 (0)