issues
search
NOAA-MDL
/
grib2io
Python interface to the NCEP G2C Library for reading and writing GRIB2 messages.
https://noaa-mdl.github.io/grib2io
MIT License
30
stars
11
forks
source link
Improved docstrings and some type hints.
#134
Closed
TimothyCera-NOAA
closed
7 months ago
TimothyCera-NOAA
commented
7 months ago
Removed markdown markup in docstrings in favor of using "--docformat numpy" for the pdoc command in create_docs.sh.
Used numpy format for the "Return" sections to be properly rendered by "pdoc --docformat numpy ...".
Removed blank lines between parameters in the "Parameters" section.
Added missing docstrings.
Minor improvements to type hints:
np.array to NDArray,
Optional[] wherever argument could be None,
Addition of Union where needed.