Docstring/typo fixes

[truth-quark]

This is a documentation cleanup PR. Most fixes are docstring formatting for API docs & typos.

[jeremyh]

Thanks Ben, it looks good. The only thing I'm slightly hesitant about are the docstring todos

:param cop_pathname:
        TODO.

This would have the effect of suppressing the linter warning about missing docstring parameters (if we run one) without the issue being fixed. I'd probably lean toward leaving them off (or fill in the actual text) to keep future linters correctly specific.

[uchchwhash]

Looks good. Thanks @truth-quark.

[truth-quark]

Thanks Ben, it looks good. The only thing I'm slightly hesitant about are the docstring todos

:param cop_pathname:
        TODO.

This would have the effect of suppressing the linter warning about missing docstring parameters (if we run one) without the issue being fixed. I'd probably lean toward leaving them off (or fill in the actual text) to keep future linters correctly specific.

I've got these as the newly added docstring params:

$ grep -rn TODO[.] wagl/
wagl/ancillary.py:611:        TODO.
wagl/ancillary.py:756:        TODO.
wagl/longitude_latitude_arrays.py:105:        TODO.
wagl/satellite_solar_angles.py:40:        TODO.
wagl/satellite_solar_angles.py:933:        TODO.
wagl/hdf5/__init__.py:134:        TODO.

With grep context:

$ grep -B1 -rn TODO[.] wagl/
wagl/ancillary.py-610-    :param cop_pathname:
wagl/ancillary.py:611:        TODO.
--
wagl/ancillary.py-755-    :param offshore:
wagl/ancillary.py:756:        TODO.
--
wagl/longitude_latitude_arrays.py-104-    :param depth:
wagl/longitude_latitude_arrays.py:105:        TODO.
--
wagl/satellite_solar_angles.py-39-    :param centre:
wagl/satellite_solar_angles.py:40:        TODO.
--
wagl/satellite_solar_angles.py-932-    :param trackpoints:
wagl/satellite_solar_angles.py:933:        TODO.
--
wagl/hdf5/__init__.py-133-    :param dtype:
wagl/hdf5/__init__.py:134:        TODO.

There's a few params which I don't have the context to document correctly:

• [ ] cop_pathname
• [ ] offshore
• [ ] depth
• [ ] centre
• [ ] trackpoints

The code docs are missing for some of these. Does anyone know the background for these params?

[uchchwhash]

There's a few params which I don't have the context to document correctly:

• [ ] cop_pathname
• [ ] offshore
• [ ] depth
• [ ] centre
• [ ] trackpoints

The code docs are missing for some of these. Does anyone know the background for these params?

That's okay. Thanks for clearly marking them as TODO. That will do.