Repository navigation
AGENTS.md: who runs where in an instrument plugin - #64
Merged
Merged
Conversation
…, controller) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before:
AGENTS.mdsaid that plugin code runs in a worker thread and must not touch widgets, but not which object runs where, whenmove_doneis called, or how the data of a grab reaches the viewer.After: a "Who runs where" paragraph in section 3 (instrument plugins): the control module in the GUI thread, the worker and the plugin in the plugin thread (one per controller, shared by master and slaves), the controller used in the plugin thread only; how a move ends (polling, no polling, a move that ends later) and how a grab reaches the GUI (averaging, live mode); an exception of a plugin method is shown as an error of the module. It points to the PyMoDAQ documentation page "How an instrument plugin works with the Dashboard" (
docs/src/developer_folder/plugin_workflow.rst), which holds the diagrams.How: every sentence comes from the code of
daq_move.py,daq_viewer.py,control_modules/utils.pyandmove_utility_classes.pyof PyMoDAQ 5.3.x, read for the page itself. Item P9 of the AI-friendliness plan.Tested: documentation only, no code changed. Please merge after PyMoDAQ PR #1448 (the page this refers to).
Generated by Claude Code