Correction to http_request example
#4543
Merged
Conversation
This file contains 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
The affected example code caused two errors: - a `no return statement in function returning non-void [-Werror=return-type]` caused by missing `return`s within the `if`s. - `while parsing a block mapping ... expected <block end>, but found '<scalar>'` caused by the `;` at the end of `args`
WalkthroughThe pull request modifies the error handling and logging mechanism in the Changes
Suggested reviewers
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
components/http_request.rst (1)
294-301: Improve error handling and documentation clarity.
- Fix the indentation to be consistent with the rest of the code example.
- Enhance the error message by including the actual JSON response for better debugging.
- Document the boolean return values in the example's description.
Apply this diff:
- if (root["vol"]) { - id(player_volume).publish_state(root["vol"]); - return true; - } - else { - ESP_LOGI(TAG,"No 'vol' key in this json!"); - return false; - } + if (root["vol"]) { + id(player_volume).publish_state(root["vol"]); + return true; + } + else { + ESP_LOGI(TAG, "No 'vol' key found in JSON response: %s", body.c_str()); + return false; + }Also, add this description above the code example:
The lambda function returns `true` if the "vol" key is found and processed successfully, and `false` otherwise.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/http_request.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/http_request.rst (1)
Pattern **: - Do not generate or add any sequence diagrams
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
clydebarrow
approved these changes
Dec 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The affected example code caused two errors:
no return statement in function returning non-void [-Werror=return-type]caused by missingreturns within theifs.while parsing a block mapping ... expected <block end>, but found '<scalar>'caused by the;at the end ofargsAlso matched the example with the one at https://esphome.io/components/json#parsing-json
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): esphome/esphome#
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/index.rstwhen creating new documents for new components or cookbook.