Repository navigation
README: keep Authors and Instruments first - #20
Merged
Merged
Conversation
The plugin manager reads the README in the order Authors, Instruments. 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: since #17 the README has the sections "Difference with the 5.3.x branch" and "Requirements" before "Authors" and "Instruments".
After: the introduction stays short, then "Authors", "Contributors", "Instruments" and "Documentation" come first, followed by "Difference with the 5.3.x branch" and "Requirements". Content unchanged, only moved.
How: the plugin manager (
pymodaq_plugin_manager,extract_authors_from_descriptioninvalidate.py) reads the README description starting atAuthorsand up toContributorsorInstruments, so these sections must stay in that order and nothing else should come between or before them. The file builds without warning with docutils.Generated by Claude Code