docs: document BatchTagPipeline ReadFn seam from PR #367#374
Draft
HanSur94 wants to merge 1 commit into
Draft
Conversation
PR #367 added a public 'ReadFn' constructor option to BatchTagPipeline (a DI seam for injecting a custom raw-file parser) but never updated its own docstring, so the auto-generated wiki API reference missed it. Fix the source docstring and regenerate wiki/API-Reference:-Sensors.md via scripts/generate_api_docs.py.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Owner
Author
|
The
Neither test touches Generated by Claude Code |
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
Wiki follow-up for #367 ("Tag-pipeline ReadFn seam, dashboard fixes, MISS_HIT lint cleanup").
That PR added a genuine new public feature — a
'ReadFn'constructor option onBatchTagPipeline, letting callers inject a custom raw-file parser (@(absPath)->parsed) for source formats the generic delimited reader can't handle. However, the PR never updated the class's own MATLAB docstring for this option, soscripts/generate_api_docs.py(which scrapes docstrings to buildwiki/API-Reference:-Sensors.md) never picked it up — the auto-generated wiki page silently missed the new option and its newTagPipeline:invalidReadFnerror.(The rest of #367 — the
FastSense/SparklineCardWidget/IconCardWidgetempty-data crash fixes, the MISS_HIT lint cleanup, and the.gitignorechore — is internal robustness/tooling work with no public API surface, so no further wiki changes were needed there; the FastSense doc-comment changes in that PR were already picked up automatically in the post-mergedocs: auto-update API reference from source codecommit.)Changes
libs/SensorThreshold/BatchTagPipeline.m: document'ReadFn'in the class header's error list and in the constructor's docstring (a third example line + a short explanation + the new error ID), matching the existing docstring conventions in this file.wiki/API-Reference:-Sensors.md: regenerated viapython3 scripts/generate_api_docs.py(no other pages changed) — now shows the'ReadFn'constructor example and theTagPipeline:invalidReadFnerror forBatchTagPipeline.Test plan
scripts/generate_api_docs.pyand confirmed onlywiki/API-Reference:-Sensors.mdchanged, with exactly the two intended lines added.🤖 Generated with Claude Code
https://claude.ai/code/session_01APr4Z5H8Ts437fhDtbyRYr
Generated by Claude Code