Skip to content

docs(examples): correct stale claims in examples/README.md and example docstrings - #89

Merged
dcj merged 1 commit into
mainfrom
dcj/examples-docs
Oct 4, 2026
Merged

dcj merged 1 commit into
mainfrom
dcj/examples-docs

Conversation

@dcj

@dcj dcj commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Docs-only corrections from an audit of examples/README.md and the example scripts' docstrings and --help against the code. No behavior changes.

  • utility-meter:
    • The spec path moved to devices/utility-meter.md (the old data-models/ file is a "Moved" stub). The example is still described as written against v0.3, and the published info/data-model-version stays 0.3.
    • tick() is an unimplemented stub, so the docstring and the --tick-interval help now say so instead of "simulates measurement updates".
    • The usage line shows the required --broker-config.
    • The adapter docstring lists the eight capability nodes it creates, not four.
  • examples/README.md:
    • --config / EBUS_BROKER_CFG applies to four examples, not all. utility-meter takes -b / --broker-config, and simple-span-controller builds its own config.
    • The throwaway-broker recipe used mosquitto -c <(...), which mosquitto 2.1.2 rejects ("is not a file"). It now writes a temp config file; that form was checked.
    • --check logs the root and its direct children.
  • ha-discovery-bridge: drops an internal tracker ID from the docstring.

Verification: ruff check and format pass, and --help and simple-tree-device --check were run.

🤖 Generated with Claude Code

https://claude.ai/code/session_01T32pvgqCzp1qCz7K5gS9Wm

…e docstrings

- utility-meter: the spec path moved to devices/utility-meter.md (written
  against v0.3, unchanged on the wire); tick() is an unimplemented stub, so
  say so instead of "simulates measurement updates"; usage shows the
  required --broker-config; the adapter adds eight capability nodes, not four.
- examples/README.md: --config/EBUS_BROKER_CFG applies to four examples, not
  all (utility-meter uses -b/--broker-config, simple-span-controller builds
  its own); the throwaway-broker recipe used `mosquitto -c <(...)`, which
  mosquitto 2.x refuses; --check logs the root and its direct children.
- ha-discovery-bridge: drop an internal tracker ID from the docstring.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01T32pvgqCzp1qCz7K5gS9Wm
@dcj
dcj force-pushed the dcj/examples-docs branch from 916862b to ea1539e Compare October 4, 2026 05:58
@dcj
dcj merged commit 1bc47cb into main Oct 4, 2026
5 checks passed
@dcj
dcj deleted the dcj/examples-docs branch October 4, 2026 05:59
dcj added a commit that referenced this pull request Oct 4, 2026
Bumps __version__ to 0.24.0, promotes Unreleased to [0.24.0], adds the
tag link definition.

  #86  Floor ebus-mqtt-client at 0.6.0, which holds every publish issued
       while the link is down and flushes it before the SDK's on-connect
       republish. With 0.5.0, simple-device and simple-tree-device ended
       with the root's retained $state on init instead of ready.
  #87  Device.as_dict() raised TypeError for any device with a node.

Minor rather than patch: the floor changes what a construction-time
publish does on the wire, the same reasoning that made ebus-mqtt-client
0.6.0 minor. Also in this release: examples documentation corrections (#89).


Claude-Session: https://claude.ai/code/session_01T32pvgqCzp1qCz7K5gS9Wm

Co-authored-by: Claude Opus 5.5 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant