Skip to content

AGENTS.md: required and optional plugin methods follow the PyMoDAQ plugin contract - #56

Merged
seb5g merged 1 commit into
5.3.xfrom
docs/align-plugin-contract
Oct 13, 2026
Merged

seb5g merged 1 commit into
5.3.xfrom
docs/align-plugin-contract

Conversation

@seb5g

@seb5g seb5g commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

Before: AGENTS.md said to "override at least" a long list of methods (including move_home, stop_motion, commit_settings) without saying which ones check_plugin requires, and the list differed from the one in PyMoDAQ.

After: it separates the required methods (actuator: ini_stage, get_actuator_value, move_abs, move_rel, close; detector: ini_detector, grab_data, stop, close) from the ones to override when the instrument can do it, and points to the single definition in pymodaq_utils.plugin_tools.contract and to the table in the developer guide (PyMoDAQ #1307).

How: text change in AGENTS.md only. The template tests need no change: they use the checks of PyMoDAQ, which read the contract. Making move_abs and move_rel required in check_plugin ships with the next PyMoDAQ 5.3.x release.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg


Generated by Claude Code

@seb5g
seb5g merged commit 3a34d09 into 5.3.x Oct 13, 2026
8 checks passed
@seb5g
seb5g deleted the docs/align-plugin-contract branch October 13, 2026 08:55
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

Successfully merging this pull request may close these issues.

2 participants