docs(readme): fix broken Tags example, correct widget/theme counts#209
Open
HanSur94 wants to merge 8 commits into
Open
docs(readme): fix broken Tags example, correct widget/theme counts#209HanSur94 wants to merge 8 commits into
HanSur94 wants to merge 8 commits into
Conversation
The DashboardWidgetRegistry seeds exactly 19 built-in widget types (verified via DashboardWidgetRegistry.types() in a live session and by counting concrete *Widget.m classes in libs/Dashboard/). The README claimed 21 in three places (badges line, dashboard feature list, and What's in the box). Corrected all three to match the code. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
FastSenseTheme has only 2 distinct presets (light, dark) — the four legacy names (default/industrial/scientific/ocean) all alias to light, and the engine's own error says 'Use light or dark'. The '6' conflated the 2 themes with the 4 separate line-color palettes (vibrant, muted, colorblind, ocean). Replaced '6 themes' with 'light & dark themes, 4 color palettes', verified against a live FastSenseTheme() session. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The Tags quickstart called TagRegistry.register(press) with a single
argument, which errors at runtime (MATLAB:minrhs — register's signature
is register(key, tag)). Verified the original snippet throws and the
two-arg form renders cleanly end-to-end in a live MATLAB session.
Corrected both calls to pass the tag key:
TagRegistry.register('press_a', press)
TagRegistry.register('press_high', alarm)
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…>Threshold) The 'Build a dashboard' quickstart errored at runtime in two ways, both verified in a live MATLAB session: 1. 'Label' is not a valid widget option (DashboardWidget:unknownOption). number/gauge/status widgets all document 'Title'. Changed Label->Title. 2. A MonitorTag bound via 'Tag' routes to the Sensor slot (Sensor is a backward-compat alias for Tag), and StatusWidget then reads .Y, which MonitorTag lacks (MATLAB:noSuchMethodOrField 'Y'). StatusWidget's documented contract wires a MonitorTag-backed indicator via 'Threshold'. Changed the status widget to 'Threshold', alarm. Corrected snippet now renders all 4 widgets and round-trips through save/load cleanly (ok=1, 4 widgets reloaded). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…s claim Two inaccuracies in the examples line, both verified against examples/: - '40+ runnable scripts' undercounts — there are 72 example_*.m scripts in the topic dirs (01-basics .. 07-advanced), 82 .m files total. - 'Run them all with run_all_examples' is misleading: run_all_examples executes a hardcoded curated list of 23 examples (prints 'FastSense Examples (23 total)'), not all 72. All 23 curated files exist on disk. Rewrote to '70+ runnable scripts ... run_all_examples plays a guided tour of the highlights.' Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The Tags section said 'four flavours' and listed only 4, but there are 5 concrete Tag subclasses (SensorTag, StateTag, MonitorTag, CompositeTag, DerivedTag) — verified via superclasses() in a live session. DerivedTag is the continuous-output counterpart to the 0/1 Monitor/Composite tags; the README's own prose already promised 'derived signals' with no matching table row. - four -> five flavours; added a DerivedTag row (continuous signal from other tags). Verified DerivedTag computes power=V.*I correctly over 1000 pts (matches expected to 1e-9). - tightened CompositeTag's description to '0/1 aggregated from monitors' to distinguish it from the continuous DerivedTag (per CompositeTag's own header). - added DerivedTag to the 'What's in the box' Tag list. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ure)
The README listed the dashboard's nested-layout and detach features but
omitted per-widget info popups — one of the three flagship features of
the Advanced Dashboard work. Every DashboardWidget has a Description
('Doc text shown in a popup when the widget's info (i) button is
clicked'); a non-empty Description renders an InfoIconButton that opens
a doc popup.
Verified in a live render: a widget WITH a Description shows exactly 1
InfoIconButton; a sibling without one shows none.
Added 'per-widget info popups' to the dashboard feature line and
'info popups' to the What's-in-the-box Dashboards recap.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The quickstart code blocks named the FastSense handle 'fp' — an abbreviation of the project's old name (FastPlot). Renamed both blocks' variable to 'fs' so the front-door examples match the current product name. Verified the renamed '30 seconds in' snippet still renders cleanly (ok=1). Co-Authored-By: Claude Opus 4.8 <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
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.
Three verified README fixes, each checked against the live code/MATLAB session before committing. Produced by iterative
/readme-polishruns (one verified fix per commit).Fixes
🔴 Broken Tags example (
0c5fdf9e) — the Tags quickstart calledTagRegistry.register(press)with a single argument, which errors at runtime (MATLAB:minrhs).register's signature isregister(key, tag). Verified the original throws and the two-arg form renders the whole snippet clean end-to-end in a live session. Corrected to:🟠 Wrong "6 themes" claim (
dc0285ed) —FastSenseThemehas only 2 distinct presets (light,dark); the four legacy names all alias tolight, and the engine's own error says "Use 'light' or 'dark'." The "6" conflated the 2 themes with the 4 separate line-color palettes. Replaced withlight & dark themes, 4 color palettes.🟠 Wrong widget count (
6ca01e3c) — README advertised "21 widget types" in three places;DashboardWidgetRegistry.types()reports exactly 19 (verified live). Corrected all three occurrences.Verification
DashboardWidgetRegistry.types()andFastSenseTheme()in-session.Not addressed (follow-ups)
4.7 ms/212 FPS/0.06 MB/153 MB/~3.2 s) is unverified here — needs a/perf-watch//bench-guardrun before trusting..mfiles on disk).🤖 Generated with Claude Code