docs: simplify FormattedString Method column in HTML.md#14
docs: simplify FormattedString Method column in HTML.md#14KnightNiwrem merged 1 commit intomasterfrom
Conversation
Remove template literal examples from the FormattedString Method column to fix table rendering issues caused by escaped backticks.
|
Warning Rate limit exceeded@KnightNiwrem has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 45 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
Summary of ChangesHello @KnightNiwrem, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a minor but important documentation issue by simplifying the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Pull request overview
This PR simplifies the FormattedString Method column in the HTML.md documentation by removing template literal examples that were causing table rendering issues due to escaped backticks.
- Simplified 7 rows in the Entity Reference table by removing
fmttemplate literal syntax examples - Retained only the static method syntax (e.g.,
FormattedString.bold()) for cleaner table presentation - Template literal syntax remains documented in the detailed sections below the table
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Code Review
This pull request simplifies the FormattedString Method column in the HTML formatting documentation by removing the template literal examples. This is a good change as it improves readability and fixes rendering issues with escaped backticks. I've found one small issue with the updated documentation for pre blocks, where the suggested method is not accurate. My review includes a suggestion to correct this.
| | `<s>`, `<strike>`, `<del>` | `strikethrough` | `FormattedString.strikethrough()` | | ||
| | `<span class="tg-spoiler">`, `<tg-spoiler>` | `spoiler` | `FormattedString.spoiler()` | | ||
| | `<code>` | `code` | `FormattedString.code()` | | ||
| | `<pre>` | `pre` | `FormattedString.pre()` | |
There was a problem hiding this comment.
When documenting syntax in a Markdown table, special characters like '|' must be properly escaped. 1
| | `<pre>` | `pre` | `FormattedString.pre()` | | |
| | `<pre>` | `pre` | (via `pre` entity tag) | |
Rules References
Footnotes
-
When documenting syntax in a Markdown table, special characters like '|' must be properly escaped. ↩
Remove template literal examples from the FormattedString Method column to fix table rendering issues caused by escaped backticks.