You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-7Lines changed: 6 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -171,25 +171,24 @@ Utilize a built-in style by specifying any of the following names (as a string),
171
171
in the case of overlap.
172
172
173
173
-`"numpy_with_merge"`: Behaves identically to the "numpy" style, but also merges sections that overlap,
174
-
instead of only keeping the child's section. All sections are concerned except sections "Short Summary",
175
-
"Extended Summary", "Deprecation Warning" and "Examples" for which the "numpy" style behaviour applies.
174
+
instead of only keeping the child's section. The sections that are merged are "Attributes", "Parameters",
175
+
"Methods", "Other Parameters", and "Keyword Arguments".
176
176
177
177
-`"google"`: Google-styled docstrings from the parent and child are merged gracefully
178
178
with nice formatting. The child's docstring sections take precedence in the case of overlap.
179
179
This adheres to the [napoleon specification for the Google style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google-style-python-docstrings).
180
180
181
181
-`"google_with_merge"`: Behaves identically to the "google" style, but also merges sections that overlap,
182
-
instead of only keeping the child's section. All sections are concerned except sections "Short Summary",
183
-
"Example" and "Examples" (or coresponding aliases) for which the 'google' style applies.
182
+
instead of only keeping the child's section. The sections that are merged are "Attributes", "Parameters",
183
+
"Methods", "Other Parameters", and "Keyword Arguments" (or their [aliases](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#docstring-sections)).
184
184
185
185
-`"numpy_napoleon"`: NumPy-styled docstrings from the parent and child are merged gracefully
186
186
with nice formatting. The child's docstring sections take precedence in the case of overlap.
187
187
This adheres to the [napoleon specification for the NumPy style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html#example-numpy).
188
188
189
189
-`"numpy_napoleon_with_merge"`: Behaves identically to the 'numpy_napoleon' style, but also merges sections
190
-
that overlap, instead of only keeping the child's section. All sections are concerned except sections
191
-
"Short Summary", "Example" and "Examples" (or coresponding aliases) for which the 'numpy_napoleon' style
192
-
behaviour applies.
190
+
that overlap, instead of only keeping the child's section. The sections that are merged are "Attributes", "Parameters",
191
+
"Methods", "Other Parameters", and "Keyword Arguments" (or their [aliases](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#docstring-sections)).
193
192
194
193
-`"reST"`: reST-styled docstrings from the parent and child are merged gracefully
195
194
with nice formatting. Docstring sections are specified by
0 commit comments