DOI-USGS / DOI-USGS/dataretrieval-python

wqp.py documentation improvements

Open
#163 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
265
Forks
63
Avg merge
1d 20h
Merged PRs (30d)
19

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.