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

Improve documentation of binding variables and methods #46

Open
kwin opened this issue Sep 5, 2023 · 5 comments · May be fixed by #49
Open

Improve documentation of binding variables and methods #46

kwin opened this issue Sep 5, 2023 · 5 comments · May be fixed by #49
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kwin
Copy link
Contributor

kwin commented Sep 5, 2023

All methods/objects which are provided by default in the script context should have an improved documentation.
This includes e.g. methods added via any of the classes in https://github.com/orbinson/aem-groovy-console/tree/1100331993e8799f2d6c82223e9950e5d1945fed/bundle/src/main/groovy/be/orbinson/aem/groovy/console/extension/impl/scriptmetaclass or objects added via the classes in https://github.com/orbinson/aem-groovy-console/tree/1100331993e8799f2d6c82223e9950e5d1945fed/bundle/src/main/groovy/be/orbinson/aem/groovy/console/extension/impl/binding.

The documentation in http://localhost:4502/groovyconsole is not enough, as this does not expose any description on binding variables and no detailled description on parameters for methods.

@kwin
Copy link
Contributor Author

kwin commented Sep 5, 2023

Particularly interesting is whether the underlying resourceResolver/session is derived from the user session bound to the request or always an admin or service resource resolver/session.

@kwin kwin changed the title Document all default bindings Improve documentation of binding variables and methods Sep 5, 2023
@royteeuwen
Copy link
Contributor

@kwin
Copy link
Contributor Author

kwin commented Sep 14, 2023

@royteeuwen Thanks for picking it up, but then I am wondering, what this service user is used for in Groovy Console:

@kwin
Copy link
Contributor Author

kwin commented Sep 14, 2023

Compare with the related valtech/aem-easy-content-upgrade#220

@bdhoine bdhoine self-assigned this Sep 18, 2023
@bdhoine bdhoine added the documentation Improvements or additions to documentation label Sep 18, 2023
@royteeuwen
Copy link
Contributor

@kwin interested in doing a review for the first changes? #49

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants