-
-
Notifications
You must be signed in to change notification settings - Fork 2k
[mapping] Update docs #5194
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
base: next
Are you sure you want to change the base?
[mapping] Update docs #5194
Conversation
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.
Pull Request Overview
This PR updates the documentation for the mapping component to improve readability and add new functionality details. The changes include formatting improvements, clarification of mapping usage, and examples of runtime map updates.
- Line wrapping and formatting improvements for better readability
- Added documentation for the
get()
function and runtime map updates - Extended the complex example with additional entries and usage patterns
Comments suppressed due to low confidence (1)
components/mapping.rst:95
- Mismatched brackets: there's an opening parenthesis after
get(
but a closing square bracket]
instead of a closing parenthesis. It should becolor_map.get(random_uint32() % 3)
.
auto color = color_map.get(random_uint32() % 3]); # Uses get() to index the color_map
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
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.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAME
with your component name in UPPER_CASE format with underscores (e.g.,BME280
,SHT3X
,DALLAS_TEMP
):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/
folder of this repository.Use the image in your component's index table entry in
/components/index.rst
.Example: For a component called "DHT22 Temperature Sensor", use: