docs: document GENERIC as a registered, discoverable registry key - #186
Merged
Conversation
Issue #148's code half was fixed in #142 (GenericDriver/SimulatedGeneric register under GENERIC), but the acceptance criterion — 'GENERIC is a documented, discoverable key' — was unmet: neither the DriverRegistry docstring nor supported_instruments.md mentioned it. - registry.py: DriverRegistry docstring now lists GENERIC as an always-registered key with both driver classes and its fallback role. - supported_instruments.md: new 'GENERIC (Universal Fallback)' section covering the driver, when it is selected, and its intentionally untyped SCPI passthrough API. Closes the documentation gap for #148.
abduznik
marked this pull request as ready for review
September 5, 2026 09:17
This was referenced Sep 6, 2026
abduznik
added a commit
that referenced
this pull request
Sep 7, 2026
- #148 row marked Fixed in v0.9.0 (GENERIC discoverability docs landed in PR #186; issue closed 2026-09-05) instead of 'Open (partially addressed)' - v0.9.0 version-planning row: in progress -> released 2026-09-05 - Header: Target Release -> Status: Released 2026-09-05 - Note re-verification against issue state (gh #188) Co-authored-by: abduznik <abduznik@users.noreply.github.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
1 participant
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
Issue #148 asked that
"GENERIC"be a documented, discoverable key inDriverRegistry. The code half was resolved in #142 (GenericDriverandSimulatedGenericboth register under"GENERIC"), but thedocumentation half was never done: the registry docstring documented no
keys at all, and
docs/supported_instruments.mdnever mentioned GENERIC.A caller still had to read
factory.pysource to know GENERIC exists.This PR closes that gap:
src/instrumation/drivers/registry.py— theDriverRegistrydocstring now documents the canonical type-key concept, points to
factory.KNOWN_DRIVER_TYPES, and explicitly describes"GENERIC"asan always-registered fallback key with both registered classes.
docs/supported_instruments.md— new GENERIC (UniversalFallback) section: the driver, when it is selected (explicit
driver_type="GENERIC"or unrecognized*IDN?), and its deliberatelyuntyped SCPI passthrough API (safe default, never a silent
DMM/SA misread).
Test Plan
get_drivers_by_type("GENERIC")returnsboth
GenericDriverandSimulatedGeneric; the new docs section andregistry docstring text are present. PASS.
Fixes #148