NOAA-ORR-ERD / LibGOODS

Library for accessing data useful for the NOAA / GNOME model
https://libgoods.readthedocs.io/en/latest/
Other
1 stars 2 forks source link

add some doctrings to api.py #38

Closed ChrisBarker-NOAA closed 1 year ago

ChrisBarker-NOAA commented 1 year ago

I added some documentation to api.py.

I didn't push directly to main, as I haven't had a chance to test -- all I did was comments and docstrings, so nothing should break, but you never know

@jay-hennen: I lost track of what we're still using, and what's leftover kruft -- could you take a look and correct and/or remove stuff. And merge it when you've done that (and tested)

@lukecampbell: take a look at api.py, hopefully the added docstrings will make things a bit more clear.

Note that we have a MetaData class in libgoods.models that we are using. The rest of what's in models is my original idea for a OO API to the models -- we'll probably dump all that.