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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #20

Open
kinverarity1 opened this issue Mar 28, 2020 · 0 comments
Open

Improve documentation #20

kinverarity1 opened this issue Mar 28, 2020 · 0 comments
Labels
bug Something isn't working

Comments

@kinverarity1
Copy link
Owner

Describe the bug
The JSON web service methods are too prominent in the documentation. The focus should instead be on (1) what are the bulk CSV/pandas DataFrame methods and (2) what data they return.

To Reproduce
Read the docs and be confused :-)

Expected behavior
Read the docs and be enlightened :-)

Screenshots
N/A

Desktop (please complete the following information):

  • OS: N/A
  • Python version: N/A
  • python-sa-gwdata version: 0.10

Additional context
N/A
@kinverarity1 kinverarity1 added the bug Something isn't working label Mar 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kinverarity1