DOC: add need_contiguous to GetImageViewFromArray docstring

InsightSoftwareConsortium · Nov 8, 2022 · b07aaff · b07aaff
1 parent cd9cf8d
commit b07aaff
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Modules/Bridge/NumPy/wrapping/PyBuffer.i.in b/Modules/Bridge/NumPy/wrapping/PyBuffer.i.in
@@ -72,6 +72,10 @@
         inverts the indexing scheme, the Image representation will be the
         same for an array and its transpose. If flipping is desired, see
         *np.reshape*.
+
+        By default, a warning is issued if this function is called on a non-contiguous
+        array, since a copy is performed and care must be taken to keep a reference
+        to the copied array. This warning can be suppressed with need_contiguous=False
         """
 
         assert ndarr.ndim in (1, 2, 3, 4, 5), \