Skip to content

docs: simplify FormattedString Method column in HTML.md#14

Merged
KnightNiwrem merged 1 commit intomasterfrom
fix/html-entity-reference-table
Nov 29, 2025
Merged

docs: simplify FormattedString Method column in HTML.md#14
KnightNiwrem merged 1 commit intomasterfrom
fix/html-entity-reference-table

Conversation

@KnightNiwrem
Copy link
Copy Markdown
Owner

Remove template literal examples from the FormattedString Method column to fix table rendering issues caused by escaped backticks.

Remove template literal examples from the FormattedString Method column
to fix table rendering issues caused by escaped backticks.
Copilot AI review requested due to automatic review settings November 29, 2025 09:04
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Nov 29, 2025

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between f6c99e9 and 14f69fe.

📒 Files selected for processing (1)
  • docs/HTML.md (1 hunks)
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/html-entity-reference-table

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @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 FormattedString Method column in the HTML.md file. The change removes specific template literal examples that were causing rendering problems due to escaped backticks, thereby ensuring the table displays correctly and improves the overall readability of the documentation.

Highlights

  • Documentation Update: Removed template literal examples from the FormattedString Method column in docs/HTML.md.
  • Table Rendering Fix: Resolved table rendering issues in docs/HTML.md that were caused by escaped backticks within the template literal examples.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@kilo-code-bot kilo-code-bot Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No Issues Found

1 files reviewed | Confidence: 100% | Recommendation: Merge

Review Details

Files: docs/HTML.md

Checked: Documentation accuracy, table rendering, consistency with detailed sections

Copy link
Copy Markdown

Copilot AI left a 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 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 fmt template 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.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/HTML.md
| `<s>`, `<strike>`, `<del>` | `strikethrough` | `FormattedString.strikethrough()` |
| `<span class="tg-spoiler">`, `<tg-spoiler>` | `spoiler` | `FormattedString.spoiler()` |
| `<code>` | `code` | `FormattedString.code()` |
| `<pre>` | `pre` | `FormattedString.pre()` |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

When documenting syntax in a Markdown table, special characters like '|' must be properly escaped. 1

Suggested change
| `<pre>` | `pre` | `FormattedString.pre()` |
| `<pre>` | `pre` | (via `pre` entity tag) |

Rules References

Footnotes

  1. When documenting syntax in a Markdown table, special characters like '|' must be properly escaped.

@KnightNiwrem KnightNiwrem merged commit 6ef4245 into master Nov 29, 2025
7 checks passed
@KnightNiwrem KnightNiwrem deleted the fix/html-entity-reference-table branch November 29, 2025 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants