Skip to content

Commit 9bb2c32

Browse files
committed
Reorder docstring to match numpy
1 parent 99bfe12 commit 9bb2c32

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

xarray/util/generate_reductions.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,14 @@ def {method}(
7171
New {obj} with ``{method}`` applied to its data and the
7272
indicated dimension(s) removed"""
7373

74-
TEMPLATE_SEE_ALSO = '''
74+
TEMPLATE_SEE_ALSO = """
7575
See Also
7676
--------
7777
numpy.{method}
7878
dask.array.{method}
7979
{see_also_obj}.{method}
8080
:ref:`{docref}`
81-
User guide on {docref_description}.
82-
"""'''
81+
User guide on {docref_description}."""
8382

8483
TEMPLATE_NOTES = """
8584
Notes
@@ -232,18 +231,20 @@ def generate_method(self, method):
232231

233232
yield TEMPLATE_RETURNS.format(**template_kwargs)
234233

235-
yield textwrap.indent(self.generate_example(method=method), "")
236-
237-
if method.numeric_only:
238-
yield TEMPLATE_NOTES.format(notes=_NUMERIC_ONLY_NOTES)
239-
240234
yield TEMPLATE_SEE_ALSO.format(
241235
**template_kwargs,
242236
docref=self.docref,
243237
docref_description=self.docref_description,
244238
see_also_obj=self.see_also_obj,
245239
)
246240

241+
if method.numeric_only:
242+
yield TEMPLATE_NOTES.format(notes=_NUMERIC_ONLY_NOTES)
243+
244+
yield textwrap.indent(self.generate_example(method=method), "")
245+
246+
yield ' """'
247+
247248
yield self.generate_code(method)
248249

249250
def generate_example(self, method):

0 commit comments

Comments
 (0)