Skip to content

Models: document the four kinds in AGENTS.md, drop the PID model example - #51

Merged
seb5g merged 5 commits into
5.3.xfrom
feat/models-section
Oct 11, 2026
Merged

seb5g merged 5 commits into
5.3.xfrom
feat/models-section

Conversation

@seb5g

@seb5g seb5g commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

Before: AGENTS.md said nothing about models. The template shipped a PID model whose main("BeamSteeringMockNoModel.xml") opened an experiment file that is not shipped (with the obsolete "preset" comment), and the models flag comment said "pid models" although four extensions use models.

After: a new section 6 of AGENTS.md lists the four kinds of models (PID, optimizers, data mixer, sequencer), the models = true flag and the models/ layout, and points to the working examples of pymodaq_plugins_mockexamples. The PID model template is removed and the flag comment is general.

How: documentation and removal only. check_plugin gives the same findings as before (the template's own todo markers) and the package structure test passes. Companion docs change: PyMoDAQ/PyMoDAQ#1294.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg


Generated by Claude Code

claude and others added 5 commits October 11, 2026 19:06
…ipped

The four kinds of models of the extensions are described in a new section of AGENTS.md, which points to the working examples of pymodaq_plugins_mockexamples. The PID model template, whose main() opened an experiment file that is not shipped, is removed and the models flag comment is no longer about PID only.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg
@seb5g
seb5g merged commit 20d4a74 into 5.3.x Oct 11, 2026
3 checks passed
@seb5g
seb5g deleted the feat/models-section branch October 11, 2026 19:10
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