UXARRAY / uxarray

Xarray-styled package for reading and directly operating on unstructured grid datasets following UGRID conventions
https://uxarray.readthedocs.io/
Apache License 2.0
142 stars 31 forks source link

Misleading Section Heading in Internal API #740

Open philipc2 opened 4 months ago

philipc2 commented 4 months ago

Under the Internal API, the heading "Grid Parsing and Encoding" contains groups of functions that don't belong to that family, specifically:

https://uxarray.readthedocs.io/en/latest/internal_api/index.html#grid-parsing-and-encoding

These should be under a general "Helper" section, including their previous sub-heading.

Something like what we have in our user API

https://uxarray.readthedocs.io/en/latest/user_api/index.html#helpers

Would be good to look through and see if any other sections could use modifications also.