Skip to content

AGENTS.md: keep Authors and Instruments first in the README - #22

Open
seb5g wants to merge 1 commit into
mainfrom
docs/readme-section-order
Open

seb5g wants to merge 1 commit into
mainfrom
docs/readme-section-order

Conversation

@seb5g

@seb5g seb5g commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Before: the "Done checklist" of AGENTS.md says only that the README.rst must be updated. An assistant (or a contributor) may then write requirements or notes before the Authors and Instruments sections, which breaks the way pymodaq_plugin_manager reads the README.

After: the checklist states the order (a short description, Authors, Contributors if needed, Instruments) and that other sections come after the Instruments list.

How: same sentence as the plugin template (PyMoDAQ/pymodaq_plugins_template#67). The rule comes from extract_authors_from_description in pymodaq_plugin_manager/validate.py (1.3.8): it starts at Authors and stops at Contributors or Instruments. Documentation change only, no code touched.


Generated by Claude Code

pymodaq_plugin_manager reads the README in that order.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg

seb5g commented Nov 4, 2026

Copy link
Copy Markdown
Contributor Author

The red tests and compatibility checks are not caused by this PR, which only adds docs. They come from the existing code of daq_move_PiezoConcept.py and daq_move_PiezoConceptPI, which the package structure test now rejects. The rule is PMQ302: the axes are declared as axis_names (ignored) instead of _axis_names, and _epsilons then no longer matches _axis_names. I am not fixing it here; it needs a separate code PR, which I have not opened yet.


Generated by Claude Code

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