-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Update: reformat mk for switchbot cloud #39723
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
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 Walkthrough""" WalkthroughThe SwitchBot Cloud integration documentation was extensively revised to provide a detailed and organized overview of supported devices and their functionalities. The update includes expanded device lists, clearer categorization, comprehensive tables of features, and additional clarifications, with no changes made to core logic or code entities. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation updates without modifications to control flow or feature logic. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (2)
source/_integrations/switchbot_cloud.markdown (2)
65-70
: Minor grammar – incomplete sentence and preposition
- ON/OFF for all appliance types except for *Others*
- Change temperature and mode for *Air Conditioner*
Consider “except Others” (drop the second for) and “Change temperature or mode …” for smoother reading.
- - ON/OFF for all appliance types except for *Others* - - Change temperature and mode for *Air Conditioner* + - ON/OFF for all appliance types except *Others* + - Change temperature or mode for *Air Conditioner*
167-176
: Redundant verb “get” repeated across feature listsUnder vacuums every bullet starts with “get …”. For brevity, you could drop the verb and make them noun phrases, e.g. “States”, “Battery level”, etc., or leave as-is—just flagging for consistency with earlier sections that omit the verb (“turn on or off”, “press”, etc.).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/switchbot_cloud.markdown
(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*
: Integration documentation must use the provided template structure and section order.
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
source/_integrations/switchbot_cloud.markdown
🪛 LanguageTool
source/_integrations/switchbot_cloud.markdown
[duplication] ~59-~59: Possible typo: you repeated a word.
Context: ...ges/switchbot-lock-pro) ### Sensors - Meter - [Meter Plus](https://switch-bot.com/pages/swit...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~62-~62: This phrase is duplicated. You should probably use “Meter Pro” only once.
Context: ...t-indoor-outdoor-thermo-hygrometer) - Meter Pro - [Meter Pro CO2 Monitor](https://www.switch-bot.com...
(PHRASE_REPETITION)
[duplication] ~74-~74: Possible typo: you repeated a word.
Context: ...switchbot-mini-robot-vacuum-k10-pro) - S1 - [S1 Plus](https://www.switchbot.jp/products...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~83-~83: The preposition ‘to’ seems more likely in this position.
Context: ...hModeand
customizeMode, as a Button in
pressMode` - turn on or off - press - ...
(AI_HYDRA_LEO_REPLACE_IN_TO)
[grammar] ~167-~167: You’ve repeated a verb. Did you mean to only write one of them?
Context: ... - get temperature - get humidity ### Vacuums Vacuum entities are added for K10+, K10+ Pro, ...
(REPEATED_VERBS)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/switchbot_cloud.markdown
45-45: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
46-46: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
46-46: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
47-47: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
54-54: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
55-55: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
58-58: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
59-59: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
61-61: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
65-65: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
66-66: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
71-71: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
72-72: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
81-81: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
83-83: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
88-88: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
90-90: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
93-93: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
95-95: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
97-97: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
99-99: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
104-104: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
106-106: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
108-108: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
111-111: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
113-113: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
117-117: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
119-119: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
123-123: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
125-125: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
129-129: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
131-131: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
135-135: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
137-137: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
144-144: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
146-146: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
151-151: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
153-153: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
158-158: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
161-161: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
163-163: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
166-166: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
167-167: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
171-171: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
@@ -17,6 +17,7 @@ ha_codeowners: | |||
- '@SeraphicRav' | |||
- '@laurence-presland' | |||
- '@Gigatrappeur' | |||
- '@XiaoLing-git'' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
YAML syntax broken – extra single-quote in the CODEOWNERS entry
The string is currently written as '- '@XiaoLing-git''
, which YAML parses as @XiaoLing-git'
(note the trailing quote) rather than @XiaoLing-git
.
This will break front-matter parsing and prevent the document from rendering.
- - '@XiaoLing-git''
+ - '@XiaoLing-git'
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
- '@XiaoLing-git'' | |
- '@XiaoLing-git' |
🤖 Prompt for AI Agents
In source/_integrations/switchbot_cloud.markdown at line 20, the CODEOWNERS
entry has an extra trailing single quote causing YAML syntax errors. Remove the
extra single quote so the line reads exactly '- @XiaoLing-git' without any
trailing quotes to fix the front-matter parsing and rendering issues.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/switchbot_cloud.markdown (1)
44-50
: Headings/lists still violate markdownlint – add blank-line padding throughout the sectionThe same MD022/MD032 issues called out in the previous review are still present: every
##/###/####
heading and its following list must be separated by a blank line, and lists need a blank line before/after the block.
Failing to address these will keep CI red.Example fix for the first group:
-## Supported devices -### Plugs and switches - -- [Bot (WoHand)](https://switch-bot.com/pages/switchbot-bot) +## Supported devices + +### Plugs and switches + +- [Bot (WoHand)](https://switch-bot.com/pages/switchbot-bot)Apply the same pattern to every heading/list pair in the ranges above (Locks, Sensors, Hubs, Vacuums, Supported functionality subsections, etc.).
Also applies to: 53-63, 65-75, 78-107, 108-140, 141-156, 157-176
🧹 Nitpick comments (3)
source/_integrations/switchbot_cloud.markdown (3)
60-61
: Trim trailing space in link lineLine 60 ends with a single trailing space, tripping MD009.
Remove the superfluous space to keep lint clean.- - [Indoor/Outdoor Meter (WoIOSensorTH)](https://switch-bot.com/pages/switchbot-indoor-outdoor-thermo-hygrometer) + - [Indoor/Outdoor Meter (WoIOSensorTH)](https://switch-bot.com/pages/switchbot-indoor-outdoor-thermo-hygrometer)
80-86
: Tighten wording for Bot feature listMinor language polish:
-Features: -- acted as a Switch in `switchMode` and `customizeMode`, as a Button in `pressMode` +-Features: +- acts as a Switch in `switchMode` and `customizeMode`, or as a Button in `pressMode`This avoids the past-tense “acted” and is clearer.
158-164
: Grammar cleanup for hub descriptionCurrent sentence is hard to parse. Suggest:
-Some of the hubs can be served as a bridge while the sensor data can be retrieved. Hub 2 displays temperature and humidity through a sensor cable. Without a digital display, Hub Mini Matter Enabled can also read from a sensor cable. +Some hubs act purely as bridges, exposing sensor data but not allowing device control. +• Hub 2: shows temperature and humidity via its sensor cable. +• Hub Mini (Matter-enabled): also provides temperature/humidity readings when a sensor cable is attached, but lacks a built-in display.Improves flow and splits information for readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/switchbot_cloud.markdown
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*
: Integration documentation must use the provided template structure and section order.
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
source/_integrations/switchbot_cloud.markdown
🪛 LanguageTool
source/_integrations/switchbot_cloud.markdown
[duplication] ~58-~58: Possible typo: you repeated a word.
Context: ...ges/switchbot-lock-pro) ### Sensors - Meter - [Meter Plus](https://switch-bot.com/pages/swit...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~61-~61: This phrase is duplicated. You should probably use “Meter Pro” only once.
Context: ...t-indoor-outdoor-thermo-hygrometer) - Meter Pro - [Meter Pro CO2 Monitor](https://www.switch-bot.com...
(PHRASE_REPETITION)
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ...switchbot-mini-robot-vacuum-k10-pro) - S1 - [S1 Plus](https://www.switchbot.jp/products...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~82-~82: The preposition ‘to’ seems more likely in this position.
Context: ...hModeand
customizeMode, as a Button in
pressMode` - turn on or off - press - ...
(AI_HYDRA_LEO_REPLACE_IN_TO)
[grammar] ~166-~166: You’ve repeated a verb. Did you mean to only write one of them?
Context: ... - get temperature - get humidity ### Vacuums Vacuum entities are added for K10+, K10+ Pro, ...
(REPEATED_VERBS)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/switchbot_cloud.markdown
44-44: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
45-45: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
45-45: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
46-46: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
53-53: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
54-54: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
57-57: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
58-58: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
60-60: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
64-64: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
65-65: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
70-70: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
71-71: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
80-80: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
82-82: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
87-87: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
89-89: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
92-92: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
94-94: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
96-96: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
98-98: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
103-103: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
105-105: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
107-107: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
110-110: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
112-112: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
116-116: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
118-118: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
122-122: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
124-124: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
128-128: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
130-130: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
134-134: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
136-136: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
143-143: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
145-145: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
150-150: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
152-152: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
157-157: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
160-160: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
162-162: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
165-165: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
166-166: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
170-170: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (2)
source/_integrations/switchbot_cloud.markdown (2)
118-119
: Remove the extra blank line blocks (MD012)There are two consecutive blank lines here, violating
markdownlint
rule MD012. Delete one of them to keep maximum one blank line.Also applies to: 185-186
64-64
: Trim trailing whitespaceLine 64 ends with a stray space, tripping
markdownlint
rule MD009.
Simply delete the trailing space.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/switchbot_cloud.markdown
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*
: Integration documentation must use the provided template structure and section order.
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
source/_integrations/switchbot_cloud.markdown
🪛 LanguageTool
source/_integrations/switchbot_cloud.markdown
[duplication] ~62-~62: Possible typo: you repeated a word.
Context: ...es/switchbot-lock-pro) ### Sensors - Meter - [Meter Plus](https://switch-bot.com/pages/swit...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~65-~65: This phrase is duplicated. You should probably use “Meter Pro” only once.
Context: ...t-indoor-outdoor-thermo-hygrometer) - Meter Pro - [Meter Pro CO2 Monitor](https://www.switch-bot.com...
(PHRASE_REPETITION)
[duplication] ~79-~79: Possible typo: you repeated a word.
Context: ...switchbot-mini-robot-vacuum-k10-pro) - S1 - [S1 Plus](https://www.switchbot.jp/products...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~89-~89: The preposition ‘to’ seems more likely in this position.
Context: ...hModeand
customizeMode, as a Button in
pressMode` - turn on or off - press - ...
(AI_HYDRA_LEO_REPLACE_IN_TO)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/switchbot_cloud.markdown
43-43: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
64-64: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
89-89: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
97-97: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
103-103: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
108-108: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
116-116: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
118-118: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
124-124: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
131-131: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
138-138: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
145-145: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
152-152: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
162-162: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
170-170: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
182-182: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
185-185: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
191-191: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
#### Bot | ||
|
||
Features: | ||
- acted as a Switch in `switchMode` and `customizeMode`, as a Button in `pressMode` | ||
- turn on or off | ||
- press | ||
- get battery level | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Insert a blank line before/after every bullet list inside “Features:” blocks
markdownlint
rule MD032 is triggered because the list starts immediately after the Features:
line and ends without an empty line separator.
Add one blank line after Features:
and one blank line after the list for every device block (Bot, Plug Mini, Relay Switch 1, …). While touching the lines, consider switching to the present tense (“acts” instead of “acted”) for consistency.
Example fix for one block:
-Features:
-- acted as a Switch in `switchMode` and `customizeMode`, as a Button in `pressMode`
+Features:
+
+- acts as a Switch in `switchMode` and `customizeMode`, as a Button in `pressMode`
+- turns on or off
+- presses
+- reports battery level
+
Replicate the blank-line pattern (and tense adjustment) for all the ranges listed above; this will silence the linter and improve readability.
Also applies to: 94-99, 100-111, 121-127, 128-134, 135-141, 142-148, 149-156, 159-166, 167-174, 181-184, 190-197
🧰 Tools
🪛 LanguageTool
[uncategorized] ~89-~89: The preposition ‘to’ seems more likely in this position.
Context: ...hModeand
customizeMode, as a Button in
pressMode` - turn on or off - press - ...
(AI_HYDRA_LEO_REPLACE_IN_TO)
🪛 markdownlint-cli2 (0.17.2)
89-89: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
🤖 Prompt for AI Agents
In source/_integrations/switchbot_cloud.markdown around lines 86 to 93, add a
blank line after the "Features:" line and another blank line after the bullet
list to comply with markdownlint rule MD032. Also, change the verb tense from
past ("acted") to present ("acts") for consistency. Apply the same blank line
insertion and tense correction to all other specified line ranges to improve
readability and silence the linter warnings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @XiaoLing-git 👍
Proposed change
According to the brand's requirements, modify the display interface and add product links,
and try to unify the styles of switchbot cloud and SwitchBot Bluetooth
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit