Missing API documentation for some public functions

[weiji14]

Spotted some public functions (those not starting with an underscore) that don't appear to be documented yet at https://tudelftgeodesy.github.io/sarxarray/api_reference/:

• I/O module:
  • read_metadata function. Xref Support reading metadata from SNAP corregistration results #82
• Utility
  • crop function, added in 64 Native cropping in radar coordinates #86

Could either manually add entries for these to the docs/api_reference.md file, or to avoid situations like this in the future, use something like autodoc that will ensure public functions in a module are always documented.

Side note: May also want to update these lines in the __init__.py file?

sarxarray/sarxarray/__init__.py

Lines 1 to 3 in 3a11cd0

	from sarxarray import stack
	from sarxarray._io import from_binary, from_dataset, read_metadata
	from sarxarray.utils import complex_coherence, multi_look

Not sure which functions you want to allow usage from top-level (e.g. a user calls sarxarray.crop instead of sarxarray.utils.crop), will leave it up to you to decide on the namespace.

Part of JOSS review at openjournals/joss-reviews#10492

[rogerkuou]

Hi @weiji14 , thanks for pointing this out!
The API documentation for three more functions is added by #102 . During the time of reviewing, @Simon-van-Diepen already updated the __init__.py file:

sarxarray/sarxarray/__init__.py

Lines 1 to 3 in 8bfd828

	from sarxarray import stack
	from sarxarray._io import from_binary, from_dataset, read_metadata, to_binary
	from sarxarray.utils import complex_coherence, crop, multi_look

After fixing all current Joss reviewing issues, I will make a new release and point the JOSS submission to the new release.

Also thanks for suggesting autodoc! Can be super useful! For now I documented it in #101 , since we are recently considering switching to ReadthDoc + Sphinx, due to the shadow future of MKDocs...