Skip to content

Commit 3a092e6

Browse files
committed
size 0 halo note
1 parent 3e1e3c7 commit 3a092e6

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

cf/docstring/docstring.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@
635635
============== ======================================
636636
*mode* Description
637637
============== ======================================
638-
Not provided If no positional arguments are
638+
Not provided If no positional arguments are
639639
provided then assume the
640640
``'compress'`` mode of operation with
641641
no halo added to the subspaced axes.
@@ -724,7 +724,14 @@
724724
The subspace has the same domain as the original
725725
construct. Missing data is inserted at unselected
726726
locations, unless a halo has been defined (of any
727-
size, including 0).""",
727+
size, including 0).
728+
729+
.. note:: Setting a halo size of `0` differs from not
730+
not defining a halo at all. The shape of the
731+
returned field will always be the same, but
732+
in the former case missing data will not be
733+
inserted at unselected locations (if any)
734+
within the output domain.""",
728735
# subspace valid modes Domain
729736
"{{subspace valid modes Domain}}": """Valid modes are:
730737

0 commit comments

Comments
 (0)