Skip to content
Snippets Groups Projects

docstring changes

Merged David Schäfer requested to merge docs into develop
All threads resolved!
+ 4
4
@@ -201,8 +201,8 @@ class ResamplingMixin:
The data will be sampled to regular (equidistant) timestamps.
Sampling intervals therefore get aggregated with a function, specified by
``func`` parameter and the result gets projected onto the new timestamps with a
method, specified by ``method``. The following method (keywords) are available:
``func``, the result is projected to the new timestamps using
``method``. The following methods are available:
* ``'nagg'``: all values in the range (+/- `freq`/2) of a grid point get
aggregated with func and assigned to it.
@@ -216,9 +216,9 @@ class ResamplingMixin:
----
For perfomance reasons, ``func`` will be mapped to pandas.resample methods,
if possible. However, for this to work, functions need an initialized
``__name__`` attribute, holding the functions name. Furthermore, you should
``__name__`` attribute, holding the function's name. Furthermore, you should
not pass numpys nan-functions (``nansum``, ``nanmean``,...) because they
cannot be optimised and the handling of ``NaN`` is anyhow taken care of.
cannot be optimised and the handling of ``NaN`` is already taken care of.
Parameters
----------
Loading