ssec / sift

A visualization application for satellite imagery
http://sift.ssec.wisc.edu/
GNU General Public License v3.0
46 stars 14 forks source link

Add style checks to docstrings #345

Open djhoese opened 1 year ago

djhoese commented 1 year ago

Possibly with the use of something like numpydocs although I believe we use google-style docstrings to match satpy. Bottom line is docstrings should look like:

def some_func(...):
    """Subject line single sentence on a single line starting with imperative form verb.

    Body of the docstring.

    """