docs: correct the bmd-signal-gen relationship in the README - #7
Merged
Merged
Conversation
The README claimed bmd-signal-gen "consumes it back over SDI". The dependency runs the other way: bmd-signal-gen declares display-patterns[charts,io]>=0.2.0 and imports it. SDI is what bmd-signal-gen emits to a display, not how it consumes this library. Drops the extraction provenance from the README and describes the consumer relationship plainly. REQUIREMENTS and SPEC keep theirs — the split is a recorded design decision there, not a history lesson.
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
correct the bmd-signal-gen relationship in the README
Changes
docs
Increment type: none
Target branch: main
Status: ✅
flywheel:auto-merge—docsis in auto_merge list formainQuality checks: see required status checks for live state.