Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tune documentation template to fit extention pattern #308

Open
12rambau opened this issue Oct 5, 2024 · 4 comments
Open

tune documentation template to fit extention pattern #308

12rambau opened this issue Oct 5, 2024 · 4 comments
Assignees
Labels
help wanted Extra attention is needed impact: high Something that is relevant to nearly all users kind: documentation Improvements or additions to documentation

Comments

@12rambau
Copy link
Member

12rambau commented Oct 5, 2024

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 12rambau added help wanted Extra attention is needed impact: high Something that is relevant to nearly all users kind: documentation Improvements or additions to documentation labels Oct 5, 2024
@rahulmansharamani14
Copy link

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

@rahulmansharamani14
Copy link

@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?

@12rambau
Copy link
Member Author

12rambau commented Oct 6, 2024

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
Copy link
Member Author

12rambau commented Oct 7, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed impact: high Something that is relevant to nearly all users kind: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants