uxarray icon indicating copy to clipboard operation
uxarray copied to clipboard

Misleading Section Heading in Internal API

Open philipc2 opened this issue 11 months ago • 0 comments

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

  • Core Utils
  • Visualization
  • Slicing
  • Subsetting
  • Neighbor
  • Gradients

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.

philipc2 avatar Mar 22 '24 19:03 philipc2