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

Confusing documentation in docs/ADCore/plugin_guidelines.rst #510

Open
marcomontevechi1 opened this issue Aug 24, 2024 · 0 comments
Open

Comments

@marcomontevechi1
Copy link

marcomontevechi1 commented Aug 24, 2024

This might be some misunderstanding from my part... I was reading the plugin guidelines and came accross this:

- If plugins generate new or modified NDArrays then they must call
``NDPluginDriver::doNDArrayCallbacks()`` so that registered clients can
get the values of the new arrays.

However, when searching for the function definition or documentation, I could neither find anything about it in NDPluginDriver documentation or asynNDArrayDriver documentation nor find any definition of it in the base classes in the source code.

I found only a call to the function in NDPluginScatter, but NDPluginScatter itself defines the function, so it's not called from base classes.

Should this be in documentation? Maybe it was supposed to mean NDPluginDriver::endProcessCallbacks instead of NDPluginDriver::doNDArrayCallbacks() ?

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

No branches or pull requests

1 participant