arcus / module_discovery

The module discovery app for Arcus Ed lives here.
BSD 2-Clause "Simplified" License
1 stars 1 forks source link

create callbacks/Readme.md #7

Open drelliche opened 11 months ago

drelliche commented 11 months ago

From the code review https://github.com/arcus/module_discovery/compare/main...joy-code-review

Callbacks

Callbacks are what provide interactivity with the app. When users click on interactive elements like buttons, nodes, drop-down menus, etc., callbacks are triggered. Callbacks take inputs (what was interacted with that is triggering a new action) and outputs (what will next change in our layout).

It is helpful to document what happens when a user interacts with the app... what callbacks are triggered and under what circumstances?

E.g. (and I'm probably wrong):

  • active_node_in.py is triggered when a user clicks on a node in the displayed graph which represents an asset or a button that is displaying the name of an asset. The input could be ... or ..., and the outputs...

  • add each callback here, consider adding screenshots even of the elements that are inputs and/or outputs.

drelliche commented 10 months ago

First created here: https://github.com/arcus/module_discovery/commit/18c924ea86e6bae4ce7291f92d1c6682f8275433

When the network_analysis branch gets merged into main, I will close this issue.