OceanNetworksCanada / api-python-client

Provides easy access to ONC data in Python
https://oceannetworkscanada.github.io/api-python-client/
Apache License 2.0
10 stars 9 forks source link

Add docstring to the core methods in the onc.py #9

Open kan-fu opened 10 months ago

kan-fu commented 10 months ago

For example this is for Discovery methods.

It is decided to use numpy style for the docstring. Useful link on the sphinx extension doc to auto generate doc from docstring.

Here is an example from pandas docstring guide.