Fix for typo? in filetype docstring #208
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I just ran into a minor, but confusing issue with the docstrings for the `filetype` input for `open_virtual_dataset`. When I look at the docstring (specifically [this line](https://github.com/zarr-developers/VirtualiZarr/blob/b34a1ee47572901ed6a3623c97d340157a0fa62a/virtualizarr/xarray.py#L61)), it suggests that this would work: ```python from virtualizarr import open_virtual_dataset vds = open_virtual_dataset( ..., filetype='netCDF3', ) ``` but it raises the following error <details> </details> the following works: ```python vds = open_virtual_dataset( ..., filetype='netcdf3', ) ``` Looking at the [tests](https://github.com/zarr-developers/VirtualiZarr/blob/b34a1ee47572901ed6a3623c97d340157a0fa62a/virtualizarr/tests/test_xarray.py#L341), I suspect this is simply a typo in the docstring (upercase `'CDF'` vs lowercase `'cdf'`), but maybe I am missing something? Happy to add more if desired.
jbusecke
commented
Aug 3, 2024
| @@ -58,7 +58,7 @@ def open_virtual_dataset( | |||
| File path to open as a set of virtualized zarr arrays. | |||
| filetype : FileType, default None | |||
| Type of file to be opened. Used to determine which kerchunk file format backend to use. | |||
| Can be one of {'netCDF3', 'netCDF4', 'HDF', 'TIFF', 'GRIB', 'FITS', 'zarr_v3'}. | |||
| Can be one of {'netcdf3', 'netcdf4', 'hdf4', 'tiff', 'grib', 'fits', 'zarr_v3'}. | |||
There was a problem hiding this comment.
I am not entirely shure about the other cases here, specifically 'hdf4' and 'hdf5'?
|
This should work, because we call VirtualiZarr/virtualizarr/kerchunk.py Line 90 in b34a1ee What error did you get? You didn't actually paste it into the comment above. |
|
Ughh I am a moron, haha. Let me change the test here to demonstrate. |
|
Hmm that is odd, I cannot reproduce this error here. I might have some time later to try to surface this again, sorry for the messyness.. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I just ran into a minor, but confusing issue with the docstrings for the
filetypeinput foropen_virtual_dataset.When I look at the docstring (specifically this line), it suggests that this would work:
but it raises the following error
the following works:
Looking at the tests, I suspect this is simply a typo in the docstring (upercase
'CDF'vs lowercase'cdf'), but maybe I am missing something?Happy to add more if desired.
docs/releases.rstapi.rst