-
-
Notifications
You must be signed in to change notification settings - Fork 2k
[deep_sleep] removed extra spaces #5366
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 esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughFormatting-only edits in content/components/deep_sleep.md: adjusted punctuation/whitespace in the ESP32 RTC wakeup pin list and removed an extra blank line before the closing Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal). Please share your feedback with us on this Discord post. 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. Comment |
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
🧹 Nitpick comments (2)
content/components/deep_sleep.md (2)
88-93
: Trim extra space before colons in option bullets.Two spaces precede the colons on these lines; reduce to one (or none) for consistency.
-`KEEP_AWAKE` : Keep the ESP32 awake while the wakeup pin is still active. Or in other words: defer the +`KEEP_AWAKE`: Keep the ESP32 awake while the wakeup pin is still active. Or in other words: defer the -`INVERT_WAKEUP` : When deep sleep was set up to wake up on a HIGH signal, but the wakeup pin is already HIGH, +`INVERT_WAKEUP`: When deep sleep was set up to wake up on a HIGH signal, but the wakeup pin is already HIGH,
110-123
: Normalize spacing before colons in wakeup cause list.There’s a double space before the colon after each code literal; remove it for cleaner typography.
-- **0** - `ESP_SLEEP_WAKEUP_UNDEFINED` : In case of deep sleep, reset was not caused by exit from deep sleep +- **0** - `ESP_SLEEP_WAKEUP_UNDEFINED`: In case of deep sleep, reset was not caused by exit from deep sleep -- **1** - `ESP_SLEEP_WAKEUP_ALL` : Not a wakeup cause, used to disable all wakeup sources with esp_sleep_disable_wakeup_source +- **1** - `ESP_SLEEP_WAKEUP_ALL`: Not a wakeup cause, used to disable all wakeup sources with esp_sleep_disable_wakeup_source -- **2** - `ESP_SLEEP_WAKEUP_EXT0` : Wakeup caused by external signal using RTC_IO +- **2** - `ESP_SLEEP_WAKEUP_EXT0`: Wakeup caused by external signal using RTC_IO -- **3** - `ESP_SLEEP_WAKEUP_EXT1` : Wakeup caused by external signal using RTC_CNTL +- **3** - `ESP_SLEEP_WAKEUP_EXT1`: Wakeup caused by external signal using RTC_CNTL -- **4** - `ESP_SLEEP_WAKEUP_TIMER` : Wakeup caused by timer +- **4** - `ESP_SLEEP_WAKEUP_TIMER`: Wakeup caused by timer -- **5** - `ESP_SLEEP_WAKEUP_TOUCHPAD` : Wakeup caused by touchpad +- **5** - `ESP_SLEEP_WAKEUP_TOUCHPAD`: Wakeup caused by touchpad -- **6** - `ESP_SLEEP_WAKEUP_ULP` : Wakeup caused by ULP program +- **6** - `ESP_SLEEP_WAKEUP_ULP`: Wakeup caused by ULP program -- **7** - `ESP_SLEEP_WAKEUP_GPIO` : Wakeup caused by GPIO (light sleep only on ESP32, S2 and S3) +- **7** - `ESP_SLEEP_WAKEUP_GPIO`: Wakeup caused by GPIO (light sleep only on ESP32, S2 and S3) -- **8** - `ESP_SLEEP_WAKEUP_UART` : Wakeup caused by UART (light sleep only) +- **8** - `ESP_SLEEP_WAKEUP_UART`: Wakeup caused by UART (light sleep only) -- **9** - `ESP_SLEEP_WAKEUP_WIFI` : Wakeup caused by WIFI (light sleep only) +- **9** - `ESP_SLEEP_WAKEUP_WIFI`: Wakeup caused by WIFI (light sleep only) -- **10** - `ESP_SLEEP_WAKEUP_COCPU` : Wakeup caused by COCPU int +- **10** - `ESP_SLEEP_WAKEUP_COCPU`: Wakeup caused by COCPU int -- **11** - `ESP_SLEEP_WAKEUP_COCPU_TRAP_TRIG` : Wakeup caused by COCPU crash +- **11** - `ESP_SLEEP_WAKEUP_COCPU_TRAP_TRIG`: Wakeup caused by COCPU crash -- **12** - `ESP_SLEEP_WAKEUP_BT` : Wakeup caused by BT (light sleep only) +- **12** - `ESP_SLEEP_WAKEUP_BT`: Wakeup caused by BT (light sleep only)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/components/deep_sleep.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/deep_sleep.md
🔇 Additional comments (1)
content/components/deep_sleep.md (1)
22-24
: LGTM on whitespace fix; please verify RTC pin list completeness.The formatting tweak reads well. Double‑check whether the ESP32 RTC‑capable list should also include GPIO33–GPIO38 (input‑only) or clarify why they’re omitted. If intentional, consider a brief note to avoid confusion.
Description:
Minor change with a few spaces removed.
Checklist:
I am merging into
next
because this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
current
because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rst
when creating new documents for new components or cookbook.