Skip to content

fix filetypes in doc of open_virtual_dataset #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

lesimppa
Copy link

Hi everyone. While playing out with the repo I've noticed that the doc was off for open_virtual_dataset and its filetype parameter:

Can be one of {'netCDF3', 'netCDF4', 'HDF', 'TIFF', 'GRIB', 'FITS', 'dmrpp', 'kerchunk'}.

The doc uses capitalized filetypes while the enum uses lowercase. This PR fixes the doc.

Example:

enum: {'tiff', 'hdf5', 'hdf4', 'kerchunk', 'fits', 'netcdf3', 'grib', 'dmrpp', 'netcdf4'}
doc: {'HDF', 'netCDF3', 'netCDF4', 'TIFF', 'GRIB', 'kerchunk', 'dmrpp', 'FITS'}

Let me know if this needs further work.

@lesimppa lesimppa marked this pull request as ready for review April 10, 2025 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant