search

pytroll / pyorbital

Orbital and astronomy computations in python
http://pyorbital.readthedocs.org/
GNU General Public License v3.0
224 stars 77 forks source link

docstring fixes #50

Closed tpltnt closed 4 years ago

tpltnt commented 4 years ago

Hi there,

this PR fixes a few docstrings to render useful HTML (e.g. for readthedocs).

Cheers, tpltnt

coveralls commented 4 years ago

Coverage Status

Coverage remained the same at 83.875% when pulling 1d55a8eed89c91839e8cd6f1fbed683eb6b3baab on tpltnt:master into 7efe253e20253f3a28501d4f2a4a86efa33805e4 on pytroll:master.

djhoese commented 4 years ago

@mraspaud Were these docstrings perhaps written with the napolean extension in mind for interpreting google style docstrings?

djhoese commented 4 years ago

Thanks @tpltnt! Did you try running the make html command to render this an make sure it appears as you expect?

tpltnt commented 4 years ago

Yes I did. It looks good on my machine :D