search

cpelley / iris

A powerful, easy to use, and community-driven Python library for analysing and visualising meteorological and oceanographic data sets.
http://scitools.org.uk/iris/
0 stars 0 forks source link

Revised docstring for analysis.interpolator. #11

Closed pp-mo closed 10 years ago

pp-mo commented 10 years ago

I think I spotted a slight bug at : https://github.com/cpelley/iris/blob/interp_refactor/lib/iris/analysis/_interpolator.py#L173 Lines 173-185 should only execute when the cached "self._interpolator" is created, to set the mode -- so they should indented further, to be in the previous 'if' block

rhattersley commented 10 years ago

The class docstring for Linear states:

This class provides support for creating an interpolator that performs
linear interpolation over one or more orthogonal coordinates.

Which doesn't really reflect the primary usage - i.e. describing an interpolation scheme (e.g. for use with Cube.interpolate).

Similarly, the module level docstring could do with mentioning the existence of the interpolation-scheme classes.

pp-mo commented 10 years ago

Closed until API misconception is fixed (https://github.com/cpelley/iris/pull/11#discussion_r11255673)