MCPcopy Index your code
hub / github.com/pydata/xarray / _inject_docstring

Function _inject_docstring

xarray/computation/weighted.py:556–579  ·  view source on GitHub ↗
(cls, cls_name)

Source from the content-addressed store, hash-verified

554
555
556def _inject_docstring(cls, cls_name):
557 cls.sum_of_weights.__doc__ = _SUM_OF_WEIGHTS_DOCSTRING.format(cls=cls_name)
558
559 cls.sum.__doc__ = _WEIGHTED_REDUCE_DOCSTRING_TEMPLATE.format(
560 cls=cls_name, fcn="sum", on_zero="0"
561 )
562
563 cls.mean.__doc__ = _WEIGHTED_REDUCE_DOCSTRING_TEMPLATE.format(
564 cls=cls_name, fcn="mean", on_zero="NaN"
565 )
566
567 cls.sum_of_squares.__doc__ = _WEIGHTED_REDUCE_DOCSTRING_TEMPLATE.format(
568 cls=cls_name, fcn="sum_of_squares", on_zero="0"
569 )
570
571 cls.var.__doc__ = _WEIGHTED_REDUCE_DOCSTRING_TEMPLATE.format(
572 cls=cls_name, fcn="var", on_zero="NaN"
573 )
574
575 cls.std.__doc__ = _WEIGHTED_REDUCE_DOCSTRING_TEMPLATE.format(
576 cls=cls_name, fcn="std", on_zero="NaN"
577 )
578
579 cls.quantile.__doc__ = _WEIGHTED_QUANTILE_DOCSTRING_TEMPLATE.format(cls=cls_name)
580
581
582_inject_docstring(DataArrayWeighted, "DataArray")

Callers 1

weighted.pyFile · 0.85

Calls 1

formatMethod · 0.45

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…