From 7bc90193ed522e94c79145b79cd6667ac1013969 Mon Sep 17 00:00:00 2001 From: Simon Perkins Date: Tue, 19 Mar 2024 10:38:16 +0200 Subject: [PATCH] Modify docstring --- xarrayfits/fits.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/xarrayfits/fits.py b/xarrayfits/fits.py index f28b7be..6a088cf 100644 --- a/xarrayfits/fits.py +++ b/xarrayfits/fits.py @@ -180,7 +180,7 @@ def xds_from_fits(fits_filename, hdus=None, name_prefix="hdu", chunks=None): Parameters ---------- fits_filename : str - FITS filename + FITS filename. This can contain a globbed pattern. hdus : integer or list of integers, optional hdus to represent on the returned Dataset. If ``None``, all HDUs are selected @@ -195,8 +195,10 @@ def xds_from_fits(fits_filename, hdus=None, name_prefix="hdu", chunks=None): Returns ------- list of :class:`xarray.Dataset` - xarray Datasets containing DataArray's representing the - specified HDUs on the FITS file. + A list of xarray Datasets corresponding to glob matches + in the ``fits_filename`` parameter. + Each Dataset contains the DataArray's corresponding + to each HDU on the FITS file. """ openfiles = fsspec.open_files(fits_filename)