docs: fix documentation drift from code#59
Merged
Conversation
Static audit of docs against the code surfaced 16 discrepancies, fixed here: - Copy-paste breaks: CustomScaling kwargs (to_physical_fn/to_raw_fn), Measurement.value -> .latest, dead reference link (nominal_instrument.md -> instrument.md). - Wrong API contract: check_errors() documented as a base no-op -> private per-driver _check_errors() convention (dmm, eload); fetch_analog() takes no args; i2c set_bitrate is kHz not Hz. - Stale names/links: LabJackDAQDriver -> LabJackTSeriesDriver, ConnectPublisher -> NominalConnectPublisher, repo slug nominal-io/instrumentation -> nominal-io/instro. - Incomplete: overview lists MCC, InstroDMM, ModbusDevice; daq driver-dev section documents read/write_digital_port. - Minor: malformed write_digital_line bullet, _read_to_measurements default_tags param, set_aperture_seconds bundled-driver note, define_background_daemon(method, ...) signature. Also routed hosted-docs URLs: SDK reference/changelog -> nominal-io.github.io/instro/, user-facing prose/examples -> instro.nominal.io. Closes #58
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Error checking is an optional per-driver _check_errors() convention, not a required base method, so it doesn't belong in the "A <category> driver must:" responsibility lists. Removed it from the PSU, DMM, and ELoad lists; the convention is still shown in each representative/custom driver example and noted in the summaries.
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.
Static audit of the docs against the code (4 parallel reviewers over disjoint slices, every finding verified against source) surfaced 16 discrepancies. All fixed here. The v1.0 version-naming framing was reviewed and intentionally kept as-is.
Tier 1: copy-paste breaks (documented code raised if run)
CustomScaling(to_physical=…, to_raw=…)→ real kwargsto_physical_fn/to_raw_fn(protocols/i2c/system-definition.mdx)Measurement.value→.latest(publishers.mdx)reference/nominal_instrument.md→reference/instrument.md(reference/src/index.md)Tier 2: wrong API contract
check_errors()documented as a base-class no-op to override → it's a private, per-driver_check_errors()convention; the base has no such method (dmm.mdx,eload.mdx)fetch_analog(hw_timing_config)→ base takes no args (daq.mdx)set_bitratedocumented in Hz → code uses kHz (protocols/i2c/overview.mdx)Tier 3: stale names / links
LabJackDAQDriver→LabJackTSeriesDriver(driver-dependencies.mdx)ConnectPublisher→NominalConnectPublisher(overview.mdx)nominal-io/instrumentation→nominal-io/instro(contrib.mdx,custom-instruments.mdx,examples.mdx,mkdocs.yml,docs.json,migration/v1.mdx)Tier 4: incomplete (newly-shipped capability undocumented)
overview.mdxnow lists MCC,InstroDMM,ModbusDevicedaq.mdxdriver-dev section now documentsread_digital_port/write_digital_port(feat(daq): implement digital port read/write for NI and Keysight drivers #50)Tier 5: minor
write_digital_linemarkdown bullet (daq.mdx)_read_to_measurementssignature missingdefault_tags(daq.mdx)set_aperture_secondsnot implemented by bundled DMM drivers — noted (dmm.mdx)define_background_daemon(method, …)signature (psu.mdx,eload.mdx)Hosted-docs URL routing
nominal-io.github.io/instro/instro.nominal.ioNotes
.pychanged (check-and-testunaffected) and no example-mirror files touched (check-examples-driftunaffected).Closes #58