Skip to content

Commit 7d9c32f

Browse files
committed
add missing docs
1 parent 31ec154 commit 7d9c32f

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

cf/subspacefield.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,13 @@ class SubspaceField(mixin.Subspace):
144144
locations, unless a halo has been defined (of any
145145
size, including 0).
146146
147+
.. note:: Setting a halo size of `0` differs from not not
148+
defining a halo at all. The shape of the
149+
returned field will always be the same, but in
150+
the former case missing data will not be
151+
inserted at unselected locations (if any) within
152+
the output domain.
153+
147154
In addition, an extra positional argument of ``'test'`` is
148155
allowed. When provided, the subspace is not returned,
149156
instead `True` or `False` is returned depending on whether

0 commit comments

Comments
 (0)