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

wqp.py documentation improvements #163

Open
ehinman opened this issue Sep 17, 2024 · 0 comments
Open

wqp.py documentation improvements #163

ehinman opened this issue Sep 17, 2024 · 0 comments

Comments

@ehinman
Copy link
Collaborator

ehinman commented Sep 17, 2024

As noted by @jzemmels, a new dataretrieval-python user might find the swagger docs and webservice documentation a little tough to get the hang of. Ideally, we'd have the kwargs specified for each function within the function documentation, but it's tricky when the service arguments may not be stable over time. This increases developer burden to update documentation in the repository. However, there might be a compromise where we provide a little better descriptors of the functions and what the user might expect to learn from the webservice links/swagger docs.

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

No branches or pull requests

1 participant