Skip to content

Fix markdown bindings A-B #19012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 26, 2025
Merged

Fix markdown bindings A-B #19012

merged 14 commits into from
Jul 26, 2025

Conversation

lsiepel
Copy link
Contributor

@lsiepel lsiepel commented Jul 22, 2025

Ref: #19011

Signed-off-by: Leo Siepel <[email protected]>
Copy link
Contributor

@ccutrer ccutrer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for amazonechocontrol

Copy link
Member

@david-pace david-pace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The boschshc change should be double-checked, it is validated as incorrect in the WikiText editor.

Copy link
Contributor

@psmedley psmedley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm for amberelectric

@lsiepel lsiepel requested a review from david-pace July 22, 2025 22:14
Copy link
Contributor

@cweitkamp cweitkamp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM f0r avmfritz

Copy link
Member

@david-pace david-pace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed a problem in the ahawastecollection changes that should be double-checked

@lsiepel lsiepel requested a review from david-pace July 24, 2025 20:24
@wborn wborn requested a review from Copilot July 26, 2025 09:37
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR fixes markdown formatting issues in binding documentation files, including inconsistent numbering lists, improper italic/bold emphasis syntax, missing table headers, and other formatting improvements to enhance readability and consistency across multiple binding README files.

  • Standardizes numbered list formatting by changing mixed numbering (0,1,2,3... or 2,3,4...) to consistent sequential numbering (1,1,1...)
  • Converts asterisk-based emphasis to underscore-based emphasis for italics and double asterisk to double underscore for bold text
  • Fixes table formatting issues including missing separators and improper header formatting
  • Corrects minor spelling errors and improves documentation clarity

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
bundles/org.openhab.binding.broadlink/README.md Fixes numbered list formatting, table separator, and emphasis syntax consistency
bundles/org.openhab.binding.boschshc/README.md Updates table of contents links to remove forward slashes
bundles/org.openhab.binding.bondhome/README.md Adds missing table separator line
bundles/org.openhab.binding.bluetooth.daikinmadoka/README.md Reformats channel table with proper alignment and escaping
bundles/org.openhab.binding.bambulab/README.md Fixes list numbering and code block language specification
bundles/org.openhab.binding.avmfritz/README.md Converts asterisk emphasis to underscore emphasis
bundles/org.openhab.binding.automower/README.md Removes extra blank line
bundles/org.openhab.binding.argoclima/README.md Standardizes emphasis formatting throughout document
bundles/org.openhab.binding.anthem/README.md Converts asterisk emphasis to underscore emphasis in table
bundles/org.openhab.binding.androidtv/README.md Fixes code formatting and removes trailing blank line
bundles/org.openhab.binding.amberelectric/README.md Adds missing table separator
bundles/org.openhab.binding.amazonechocontrol/README.md Extensive formatting fixes including lists, emphasis, and section headers
bundles/org.openhab.binding.airquality/README.md Corrects grammar and spelling errors
bundles/org.openhab.binding.airparif/README.md Fixes coordinate formatting and improves table presentation
bundles/org.openhab.binding.airgradient/README.md Converts URLs to proper markdown links and improves formatting
bundles/org.openhab.binding.ahawastecollection/README.md Corrects spelling errors and improves documentation clarity
bundles/org.openhab.binding.adorne/README.md Adds missing table separators
bundles/org.openhab.automation.pythonscripting/README.md Fixes numbered lists and removes extra blank lines
bundles/org.openhab.automation.pidcontroller/README.md Standardizes list numbering and emphasis formatting
bundles/org.openhab.automation.jsscripting/README.md Fixes list numbering and removes extra blank lines
Comments suppressed due to low confidence (1)

bundles/org.openhab.binding.ahawastecollection/README.md:65

  • There's a typo in the item name and channel reference. 'leightweightPackaging' should be 'lightweightPackaging' to match the corrected description.
DateTime collectionDay_lightweightPackaging "Next lightweight packaging collection" {channel="ahawastecollection:collectionSchedule:wasteCollectionSchedule:leightweightPackaging"}

Copy link
Member

@wborn wborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👇 This branch has conflicts that must be resolved

Copy link
Member

@wborn wborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏😃

@wborn wborn merged commit 9440628 into openhab:main Jul 26, 2025
2 checks passed
@wborn wborn added this to the 5.1 milestone Jul 26, 2025
@lsiepel lsiepel deleted the fix/markdown-issues-a-b branch July 26, 2025 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants