Merge branch 'main' of https://github.com/sunpy/ndcube into nddataArithmetic2

Author: DanRyanIrish

changelog/885.doc.rst

@@ -0,0 +1 @@
+Fix a mistake in the docstring for `ndcube.NDCube.rebin`, which misdescribed the behaviour of the ``-1`` sentinel value.

ndcube/ndcube.py

@@ -1171,8 +1171,9 @@ def rebin(self, bin_shape, operation=np.mean, operation_ignores_mask=False, hand
             Each element must be in int. If they are not they will be rounded
             to the nearest int. If provided as a `~astropy.units.Quantity` the
             units have to be convertible to pixels.
-            The sentinel value ``-1`` can be passed for a dimension which means
-            that no rebinning will occur along that dimension.
+            The sentinel value ``-1`` can be passed for a dimension which sets the
+            bin size equal to the number of pixels along that axis. This results in a
+            pixel size of 1 for this axis in the output (e.g. sum along that axis).
             Please note the ``bin_shape`` follows array axis (NumPy) ordering of the axes.
         operation : function
             Function applied to the data to derive values of the bins.