docs: correct four stale claims and two markdownlint errors - #53
Merged
Conversation
Found while writing the 0.20.0 docs; none is caused by that work, and each would have shipped a third release saying something untrue. - README Requirements pinned `ebus-mqtt-client >= 0.3.0` while pyproject.toml has required >= 0.4.0 since 0.18.0. Also notes what 0.4.0 added (asyncio_driver), matching how the other floors are annotated. - Two comments in homie.py said the Homie 5 empty-string encoding was "not yet implemented (SDK-ef1 / known limitation)". It is implemented, a few lines below the first of them, via encode_empty_string(). The distinction the comments draw is still the point and is kept: a zero-length payload retracts a retained topic, a 1-character 0x00 payload is an empty-string VALUE. - adapter.py said registering the mirror means "every value change republishes to MQTT". Still true of a change, but the Homie layer now gates a republish whose wire payload is unchanged, and this docstring is the documented seam between the two dedup layers, so it should say which is which. - markdownlint: a code fence at column 0 broke ordered-list continuity in ha-discovery-bridge.md (MD029, "2." read as a new list starting at 2), and fences inside list items lacked surrounding blank lines in packaging-for-legacy-setuptools.md (MD031). Both diffs are whitespace only. Ruff's extend-exclude keeps *.md out of check and format, so nothing in CI would ever have caught these. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
dcj
force-pushed
the
docs/correct-stale-claims
branch
from
August 13, 2026 06:34
6f80238 to
301c07b
Compare
dcj
added a commit
that referenced
this pull request
Aug 13, 2026
Bumps __version__ to 0.20.0 (single source of truth), promotes Unreleased to [0.20.0], and adds the compare/tag link definitions. Two API-visible changes: property values are no longer republished when the wire payload is unchanged (#50), and declare_lost() / stop(announce=False) close the teardown gap (#46). Plus four stale doc claims corrected (#53).
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.
Found while writing the 0.20.0 docs. None is caused by that work; each would otherwise have shipped a third consecutive release saying something untrue.
README.mdRequirements pinnedebus-mqtt-client >= 0.3.0whilepyproject.tomlhas required>= 0.4.0since 0.18.0. Now also annotates what 0.4.0 added (asyncio_driver), matching how the other floors in that entry are annotated.Two comments in
homie.pysaid the Homie 5 empty-string encoding was "not yet implemented (SDK-ef1 / known limitation)". It is implemented, a few lines below the first of them, viaencode_empty_string(). The distinction those comments draw is still exactly the point and is kept: a zero-length payload retracts a retained topic; a 1-character0x00payload is an empty-string value.adapter.pysaid registering the mirror means "every value change republishes to MQTT". Still true of a change, but the Homie layer now gates a republish whose wire payload is unchanged, and this docstring is the documented seam between the two dedup layers, so it should say which does what.Two markdownlint errors, both whitespace-only diffs: a code fence at column 0 broke ordered-list continuity in
doc/ha-discovery-bridge.md(MD029 — the following2.was read as a new list starting at 2), and fences inside list items lacked surrounding blank lines indoc/packaging-for-legacy-setuptools.md(MD031).Ruff's
extend-exclude = ["*.md"]keeps prose out of bothcheckandformat, so nothing in CI would ever have caught the last two. Every Markdown file in the repo now passesmarkdownlint-cli2.596 tests pass; ruff check and
ruff format --checkclean.🤖 Generated with Claude Code