Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Include numpy-style doctrings for all service methods #195

Open
perrygeo opened this issue Jun 28, 2017 · 0 comments
Open

Include numpy-style doctrings for all service methods #195

perrygeo opened this issue Jun 28, 2017 · 0 comments
Labels
documentation good first issue

Comments

@perrygeo
Copy link
Contributor

Some of our service methods are missing docstrings altogether, others have narrative comments only. We should use numpy-style docstrings throughout to

  • specify Parameters, Return values
  • facilitate API doc generation
@perrygeo perrygeo mentioned this issue Jun 28, 2017
Merged
@perrygeo perrygeo self-assigned this Jul 7, 2017
@perrygeo perrygeo mentioned this issue Jul 10, 2017
Merged
4 tasks
@perrygeo perrygeo removed their assignment Aug 10, 2017
@aucontraire aucontraire mentioned this issue Oct 20, 2017
Merged
@critical-path critical-path mentioned this issue Apr 9, 2018
Merged
sgillies pushed a commit that referenced this issue May 3, 2018
@critical-path @sgillies
Include numpy-style docstrings for Analytics and Datasets services (#227
480c82d 
)

* Update analytics.py

Addresses #195.

* Update datasets.py

Addresses #195.

* Update datasets.py

* Update datasets.py
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sgillies @perrygeo