Skip to content

Commit ceba7f9

Browse files
committed
Fix docstring for all_arrays per sbilling pr review
1 parent 2f293c0 commit ceba7f9

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/diffpy/utils/diffraction_objects.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,10 +283,13 @@ def all_arrays(self):
283283
Returns
284284
-------
285285
ndarray
286-
The 2D array containing the `xarray` values in q, tth, d, and `yarray`.
286+
The shape (len(data), 4) 2D array with columns containing the `yarray` (intensity)
287+
and the `xarray` values in q, tth, d, and `yarray`.
287288
288289
Examples
289290
--------
291+
To access specific arrays individually, use these slices:
292+
290293
>>> my_do.all_arrays[:, 0] # yarray
291294
>>> my_do.all_arrays[:, 1] # xarray in q
292295
>>> my_do.all_arrays[:, 2] # xarray in tth

0 commit comments

Comments
 (0)