Skip to content

Commit 7cae02f

Browse files
committed
update readme
1 parent 2e5b163 commit 7cae02f

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,25 +171,24 @@ Utilize a built-in style by specifying any of the following names (as a string),
171171
in the case of overlap.
172172

173173
- `"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".
176176

177177
- `"google"`: Google-styled docstrings from the parent and child are merged gracefully
178178
with nice formatting. The child's docstring sections take precedence in the case of overlap.
179179
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).
180180

181181
- `"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)).
184184

185185
- `"numpy_napoleon"`: NumPy-styled docstrings from the parent and child are merged gracefully
186186
with nice formatting. The child's docstring sections take precedence in the case of overlap.
187187
This adheres to the [napoleon specification for the NumPy style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html#example-numpy).
188188

189189
- `"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)).
193192

194193
- `"reST"`: reST-styled docstrings from the parent and child are merged gracefully
195194
with nice formatting. Docstring sections are specified by

0 commit comments

Comments
 (0)