Update font renderer example to avoid number to string ambiguity #4544
Conversation
If someone would add numeric characters (say `0`) like in the affected example, this error would occur:
```
Must be string, got <class 'esphome.helpers.EInt'>. did you forget putting quotes around the value?.
- 0
```
Instead, the numeric characters should be listed in a string with the other plain ones. The specials can still be added on new rows, even with commas if desired.
WalkthroughThe changes involve updating the glyph configuration for the Changes
Note: No sequence diagram is generated for this change as it is a simple configuration update to the font glyph list. 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: 0
🧹 Nitpick comments (1)
components/font.rst (1)
57-61: Minor improvements for consistency.While the Unicode representations are clear, consider these refinements for better documentation:
- "\u0020", # space - "\u002C", # , - "\u0021", # ! - "\u0022", # " - "\u0027", # ' + "\u0020", # space (whitespace) + "\u002C", # comma + "\u0021", # exclamation mark + "\u0022", # quotation mark + "\u0027", # apostropheThis makes the comments more descriptive and consistent with typical documentation standards.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/font.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/font.rst (1)
Pattern **: - Do not generate or add any sequence diagrams
🔇 Additional comments (1)
components/font.rst (1)
55-56: LGTM! Clear organization of glyphs.
The changes effectively address the number-to-string ambiguity by:
- Including numeric characters (0-9) as part of a string
- Organizing related characters on the same line
- Using commas for clear separation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
If someone would add numeric characters (say
0) like in the affected example, this error would occur:Instead, the numeric characters should be listed in a string with the other plain ones. The specials can still be added on new rows, even with commas if desired.
Also added the comma character as unicode.
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.