Skip to content

[BUG] fix docstring style for the API #1557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EmanAbdelhaleem wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[BUG] fix docstring style for the API #1557

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ plugins:
docstring_options:
ignore_init_summary: true
trim_doctest_flags: true
returns_multiple_items: false
show_docstring_attributes: true
show_docstring_description: true
show_root_heading: true
Expand All @@ -138,7 +137,7 @@ plugins:
merge_init_into_class: true
show_symbol_type_heading: true
show_symbol_type_toc: true
docstring_style: google
docstring_style: numpy
inherited_members: true
show_if_no_docstring: false
show_bases: true
Expand Down