docs: add command prefix conventions contributor guide#1035
Open
BioCam wants to merge 1 commit into
Open
Conversation
Documents a standardized verb-prefix vocabulary for PLR methods so a method's name reveals both its domain (physical machine vs in-memory resource model) and its effect (action / measurement / state read / state write). Adds the guide to the General section of the contributor toctree. Convention discussion: https://discuss.pylabrobot.org/t/standardised-plr-command-prefix-proposal/403 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
Adds a contributor guide documenting standardized verb-prefix conventions for PyLabRobot method names. A method's prefix now signals both its domain (physical machine vs in-memory resource model) and its effect (action / measurement / state-read / state-write), so callers can tell from a name whether a call will round-trip over serial or stay in process.
The guide:
move_,aspirate_,measure_,read_,request_,set_,get_,update_,assign_,unassign_, ...) and the two tables that pin each prefix to a category,fetch_,retrieve_,query_,write_, ...) to keep the vocabulary tight,The guide explicitly tells contributors (and AI assistants) not to silently rename existing methods as part of unrelated work — harmonization is a separate, scoped effort.
Forum discussion that led to this convention: https://discuss.pylabrobot.org/t/standardised-plr-command-prefix-proposal/403
Test plan
make docsbuilds without warnings<details>blocks open/close in the rendered HTML🤖 Generated with Claude Code