geetools icon indicating copy to clipboard operation
geetools copied to clipboard

tune documentation template to fit extention pattern

Open 12rambau opened this issue 1 year ago • 4 comments

Currently in the doccumentation, every page is showing the complete location of the function when every single one of them is actually attached to a GEE base object.

That would be great if the API reference pages instead of showing the internal shape of the lib was displaying how the methods are accecible to the user.

12rambau avatar Oct 05 '24 12:10 12rambau

Hi @12rambau, I'd like to work on this issue. Can you please assign it to me?

rahulmansharamani14 avatar Oct 05 '24 19:10 rahulmansharamani14

@12rambau Currently, the API documentation shows the complete internal path to the functions. For example:

geetools.lib.something.function_name

Based on the issue description, it seems like the desired documentation should reflect how users actually access these methods via a GEE base object. So, instead of the internal module path, the documentation would show something like:

gee_object.function_name

Could you confirm if this is the expected change? If not, what is?

rahulmansharamani14 avatar Oct 05 '24 20:10 rahulmansharamani14

actually it's more ee.gee_object.geetools.function_name as all the functions are hidden behind the geetools namespace. That is not true for 2 exceptions that I use on regular basis:

  • the computedObjectAccessor (that is as mentioned in the documetnation directly attached to the gee object)
  • the ee.Asset object that is purely added to the GEE API

12rambau avatar Oct 06 '24 08:10 12rambau

BTW I'm positively surprised to see you offering your help, that's super nice. Since I rebooted this package that was basically me and Rodrigo alone working on it so I wasn't very careful with my issues. I'll make them more clear and professional from now on.

12rambau avatar Oct 07 '24 05:10 12rambau