Repository navigation
Correct the instrument-simulation non-goal in README Scope - #4
Merged
Merged
Conversation
v0.2.0 shipped `lablink-sim`, a simulated bench documented in the README quickstart, which made the "No instrument simulation" non-goal false a few hundred lines below the feature contradicting it. State the distinction that is actually true: LabLink does not simulate your instrument and no driver carries a simulation code path; `lablink-sim` is a separate optional bench the real drivers reach over real protocols. The other non-goals still hold as written — there is no hosted endpoint, no GUI, no Dockerfile, and no driver parses protocol syntax — so they are left untouched. Co-Authored-By: Claude Opus 5 <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.
What changed
One bullet in the
README.mdScope section (README.md:375). Before:After:
Nothing else in the file is touched.
Why
v0.2.0 shipped
lablink-sim— two simulated instruments behind four real protocol front-ends — and the README documents it in a "Try it with no hardware" quickstart roughly 290 lines above the non-goal that denied it existed. The old bullet was simply false, and it was the kind of false that costs a reader trust in the rest of the section.The replacement keeps the real distinction the section is trying to draw: LabLink will not simulate your instrument, and no driver has a fake code path you might unknowingly be exercising.
lablink-simdoesn't violate that — it is a separate optional process the unmodified drivers talk to over real SCPI/REST/serial.The other non-goal bullets
Checked each against what the repo currently ships; all four are still accurate and were left alone:
lablink-simbinds loopback ports only.lablink-simis a third console script, not a new interface kind.grepoverlablink/interfaces/confirms no driver parses SCPI; the only SCPI parser in the tree islablink/demo/scpi.py, which is the simulated instrument speaking its own protocol, not LabLink interpreting traffic on the user's behalf.The Scope section's intro paragraph (five drivers,
externalstub, GPIB/RS-485 notes) also still matches the code.Assumptions
CHANGELOG.mdentry, per the task — this is a doc correction, not a user-facing behavior change.Testing
.venv/bin/python -m pytest -q→ 350 passed in 13.9s. The suite was green before the change as well; a README edit cannot affect it.One commit:
2ecc0e9. Not pushed, no PR opened, per instructions.🤖 Generated with Claude Code