search

CosmiQ / CometTS

Comet Time Series Toolset for working with a time-series of remote sensing imagery and user defined polygons
Apache License 2.0
63 stars 16 forks source link

Add doc strings for major functions; reformat function names per PEP 8 #10

Closed rmsare closed 5 years ago

rmsare commented 5 years ago

Every significant function should include a simple docstring to describe what it does, its arguments, and any outputs.

Related to this, I suggest renaming your functions according to conventional Python style. For example, Do_Zonal_Stats would become do_zonal_stats. Using more descriptive names, like calculate_zonal_stats, would be even better. This should be easy to do across the package and notebooks by find and replace or sed.

As noted in @zhampel's review, it would be good to run a format checker like flake8 on your codebase which would catch issues like this. It looks like you did this in your response, but there are still some small whitespace issues.

(JOSS review thread)

rmsare commented 5 years ago

The new functions are docstrings are a good improvement. Thanks for updating.