Skip to content

Commit

Permalink
docs clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
davidhassell committed Mar 17, 2022
1 parent ac52fe6 commit 38e8c45
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions cf/data/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,10 +228,13 @@ def first_non_missing_value(a, cached=None, method="index"):
Select the method used to find the first non-missing
value.
The default ``'index'`` method evaulates sequentially
elements of the flattened array. The ``'mask'`` method
finds the first non-missing value from the mask of the
whole array.
The default ``'index'`` method evaulates sequentially the
elements of the flattened array and returns when the first
non-missing value is found.
The ``'mask'`` method finds the first non-missing value of
the flattened array as that which has the same location as
the first False element of the flattened array mask.
It is considered likely that the ``'index'`` method is
fastest for data for which the first element is not
Expand Down

0 comments on commit 38e8c45

Please sign in to comment.