Remove redundant newlines in documentation #5295
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR removes redundant newlines in the ST7701S display component documentation to fix rendering issues where split sentences only show partially in IDE doc highlights.
- Consolidated multi-line
data_rateparameter description into a single line - Removed unnecessary blank lines between configuration parameters
- Improved documentation readability and IDE compatibility
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughDocumentation update in content/components/display/st7701s.md: trimmed blank lines, consolidated the data_rate description into one line, and added 20MHz to the listed valid data rate values. No parameter names or semantics changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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 (2)
content/components/display/st7701s.md (2)
97-99: Minor wording/grammar polish for data_rate + spi_modeTiny readability/consistency tweaks: add the serial comma before the final “or”, and simplify “interface to the display”.
-**data_rate** (*Optional*): Set the data rate of the SPI interface to the display. One of `80MHz`, `40MHz`, `20MHz`, `10MHz`, `5MHz`, `2MHz`, `1MHz` (default), `200kHz`, `75kHz` or `1kHz`. -**spi_mode** (*Optional*): Set the mode for the SPI interface to the display. Default is `MODE0` but some displays require `MODE3`. +**data_rate** (*Optional*): Set the data rate of the SPI interface for the display. One of `80MHz`, `40MHz`, `20MHz`, `10MHz`, `5MHz`, `2MHz`, `1MHz` (default), `200kHz`, `75kHz`, or `1kHz`. +**spi_mode** (*Optional*): Set the SPI mode used to communicate with the display. Default is `MODE0`, but some displays require `MODE3`.
130-131: Example value casing vs. allowed optionsThe “Configuration variables” list specifies
color_ordershould be one ofbgr(default) orrgb(lowercase), but the example usesRGB. If parsing is case-insensitive this is harmless; if not, it could confuse users.- color_order: RGB + color_order: rgbIf the implementation is case-insensitive, consider mentioning that explicitly in the option description to reduce support churn.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
content/components/display/st7701s.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/display/st7701s.md
🪛 LanguageTool
content/components/display/st7701s.md
[grammar] ~97-~97: There might be a mistake here.
Context: ... (default), 200kHz, 75kHz or 1kHz. - spi_mode (Optional): Set the mode fo...
(QB_NEW_EN)
🔇 Additional comments (1)
content/components/display/st7701s.md (1)
97-97: 20MHz addition: looks fine; please confirm code support and constraintsNice catch adding 20MHz. Before merging, please verify the underlying driver and validation layer actually accept 20MHz and that there aren’t board-specific caps that would make this misleading (e.g., some panels or level-shifters top out at 10–12.5MHz in practice). If this value is newly permitted in code, a quick link or note in the PR description would help future readers.
Description:
There's a newline that splits a sentence in the docs, causing the text to only render the first half in an IDE's doc highlight. Removing redundant newline(s) fixes this, also removed a few other unecessary newlines.
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
/components/index.rstwhen creating new documents for new components or cookbook.