-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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.
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
Close #8573: napoleon: Add more custom section styles #8658
Conversation
509f92d
to
88971ef
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add testcases for new behavior?
88971ef
to
0c24bc6
Compare
Hi @tk0miya, I have added the tests, changed the name, and updated the doc. Thank you for the review! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with nits!
0c24bc6
to
2d479e8
Compare
2d479e8
to
7ad85cd
Compare
I have fixed the nits, but the CircleCI tests failed after the changes. I only edited some lines inside |
Merged. Thank you for your contribution! Note: I manually re-ran the testcase and confirmed all tests passed. |
Subject: add more custom section styles
Feature or Bugfix
Purpose
napoleon_custom_sections
option does not allow to configure the style, and the default style is inconsistent with the rest of the doc. It will be nice if we can choose between a few more styles. This new feature add two more styles that can make the custom section more consistent with the Parameter section or the Return section.Behavior:
napoleon_custom_sections = [('Custom Section', 'params_style')]
or
napoleon_custom_sections = [('Custom Section', 'returns_style')]
Detail
The default style is inconsistent
Display like the parameter section
Display like the return section
Relates