Skip to content
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

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

Open
1 task done
jdbcode opened this issue Jan 23, 2025 · 0 comments
Open
1 task done
Assignees
Labels

Comments

@jdbcode
Copy link
Member

jdbcode commented Jan 23, 2025

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:

Xee/xee/ext.py

Line 146 in dfba2fa

def open(

EarthEngineBackendEntrypoint.open_dataset() includes the complete docstring:

Xee/xee/ext.py

Line 1014 in dfba2fa

def open_dataset(

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.

  • I agree to follow this project's Code of Conduct
@jdbcode jdbcode added bug Something isn't working triage A new issue that needs to be triaged labels Jan 23, 2025
@jdbcode jdbcode self-assigned this Jan 23, 2025
@jdbcode jdbcode removed bug Something isn't working triage A new issue that needs to be triaged labels Jan 23, 2025
@naschmitz naschmitz added the P2 label Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants