Notes on documentation (ongoing)

[rhugonnet]

Noting things down as I stumble upon them! I'll keep adding to the list in the next days :slightly_smiling_face:

• [ ] Wrong module in example for set_max_resources() (fails with icesat2, should be earthdata?): https://slideruleearth.io/web/rtd/api_reference/earthdata.html?highlight=set_max#set-max-resources,
• [ ] Hard to have an overview of ICESat-2 parameters on page: https://slideruleearth.io/web/rtd/user_guide/ICESat-2.html. Also, parameters names don't come up when searching the documentation (trying "ats" gives empty search results for example). Only solution right now is to Ctrl+F. Improvement: We could have a summary table at the top with all parameters that points to the relevant section in the page?
• [ ] What is the unit for the "number of resources" in description of set_max_resources(): an ICESat-2 granule? an AWS processing resource? Clarify for the non-expert user!
• [ ] For set_max_resources: give a hint in the error message on what is the best "max" limit users should aim for to maximize performance. (and advice to perform subsetting on their side? not sure I understand all in this issue yet)
• [ ] Clarify behaviour of sliderule.toregion() for multi-features shapefiles (is it doing a convexhull of all dissolved features?), if I didn't miss the explanation in the docs! (nothing in https://slideruleearth.io/web/rtd/user_guide/SlideRule.html#polygons),
• [ ] Same for poly and region parameters? (it is already described in the docs but can maybe be further clarified?)
• [ ] Clarify that order matters for set_max_resources, and can be used also as an argument to init (see #344).

[jpswinski]

From @dshean: add notes on what each log level will report for SlideRule.