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
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -170,23 +170,23 @@ Utilize a built-in style by specifying any of the following names (as a string),
170
170
from the parent and child are merged gracefully with nice formatting. The child's docstring sections take precedence
171
171
in the case of overlap.
172
172
173
-
-`"numpy_with_merge"`: Behaves identically to the "numpy" style, but also merges sections that overlap,
173
+
-`"numpy_with_merge"`: Behaves identically to the "numpy" style, but also merges - with de-duplication - sections that overlap,
174
174
instead of only keeping the child's section. The sections that are merged are "Attributes", "Parameters",
175
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
-
-`"google_with_merge"`: Behaves identically to the "google" style, but also merges sections that overlap,
181
+
-`"google_with_merge"`: Behaves identically to the "google" style, but also merges - with de-duplication - sections that overlap,
182
182
instead of only keeping the child's section. The sections that are merged are "Attributes", "Parameters",
183
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
-
-`"numpy_napoleon_with_merge"`: Behaves identically to the 'numpy_napoleon' style, but also merges sections
189
+
-`"numpy_napoleon_with_merge"`: Behaves identically to the 'numpy_napoleon' style, but also merges - with de-duplication - sections
190
190
that overlap, instead of only keeping the child's section. The sections that are merged are "Attributes", "Parameters",
191
191
"Methods", "Other Parameters", and "Keyword Arguments" (or their [aliases](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#docstring-sections)).
192
192
@@ -197,7 +197,7 @@ Utilize a built-in style by specifying any of the following names (as a string),
197
197
198
198
For the `numpy`, `numpy_with_merge`, `numpy_napoleon`, `numpy_napoleon_with_merge`, `google` and `google_with_merge` styles, if the parent's docstring contains a "Raises" section and the child's docstring implements a "Returns" or a "Yields" section instead, then the "Raises" section is not included in the resulting docstring. This is to accomodate for the relatively common use case in which an abstract method/property raises `NotImplementedError`. Child classes that implement this method/property clearly will not raise this. Of course, any "Raises" section that is explicitly included in the child's docstring will appear in the resulting docstring.
199
199
200
-
Detailed documentation and example cases for the default styles can be found [here](https://github.com/meowklaski/custom_inherit/blob/master/custom_inherit/_style_store.py)
200
+
Detailed documentation and example cases for the default styles can be found [here](https://github.com/rsokl/custom_inherit/blob/master/src/custom_inherit/_style_store.py)
0 commit comments