[Bug]: open_dataset function is not documented in public docs (in helpful way)

Open jdbcode opened this issue 1 year ago • 0 comments

Bug Summary

open_dataset is not listed in API docs: https://xee.readthedocs.io/en/latest/api.html

xee.EarthEngineStore includes all of the parameters, but does not inlcude descriptions. https://xee.readthedocs.io/en/latest/_autosummary/xee.EarthEngineStore.html#xee.EarthEngineStore

I believe the open function is what is being documented: https://github.com/google/Xee/blob/dfba2faa99a73df1d4687cf7245eb26e75e22c41/xee/ext.py#L146

EarthEngineBackendEntrypoint.open_dataset() includes the complete docstring: https://github.com/google/Xee/blob/dfba2faa99a73df1d4687cf7245eb26e75e22c41/xee/ext.py#L1014

We can see EarthEngineBackendEntrypoint.open_dataset() in the docs, but it does not include helpful information on parameters and is buried in EarthEngineBackendEntrypoint class, which is not an intuitive place for people to look.

[x] I agree to follow this project's Code of Conduct

Jan 23 '25 18:01 jdbcode