search

stactools-packages / goes-glm

stactools package for the Geostationary Lightning Mapper (GLM) on the GOES satellites
Other
2 stars 1 forks source link

Add documentation strings #15

Closed gadomski closed 2 years ago

gadomski commented 2 years ago

All public functions (e.g. stactools.goes_glm.parquet.create_asset should have a documentation string describing their purpose. It doesn't need to be a fully fleshed-out example w/ args, return type, etc; just a small blurb is fine for now.

m-mohr commented 2 years ago

Can surely add the doc strings (regardless of the following comment).

Although now that you talk about "public" functions, I'm wondering whether they should actually be public or not.