Skip to content

docs: remove examples column from entity reference tables#13

Merged
KnightNiwrem merged 2 commits intomasterfrom
fix/entity-reference-tables
Nov 29, 2025
Merged

docs: remove examples column from entity reference tables#13
KnightNiwrem merged 2 commits intomasterfrom
fix/entity-reference-tables

Conversation

@KnightNiwrem
Copy link
Copy Markdown
Owner

@KnightNiwrem KnightNiwrem commented Nov 29, 2025

Remove the 'Example' column from entity reference tables in Markdown.md and MarkdownV2.md to match the format used in HTML.md.

Also fix the broken table in MarkdownV2.md caused by incorrectly escaped markdown (|| in expandable blockquote row).

Summary by CodeRabbit

Release Notes

  • Documentation
    • Streamlined Entity Reference tables in Markdown documentation by removing examples and consolidating columns to focus on Syntax, MessageEntity Type, and FormattedString Method mappings for improved clarity.

✏️ Tip: You can customize this high-level summary in your review settings.

Remove the 'Example' column from entity reference tables in Markdown.md
and MarkdownV2.md to match the format used in HTML.md.

Also fix the broken table in MarkdownV2.md caused by incorrectly
escaped markdown (|| in expandable blockquote row).
Copilot AI review requested due to automatic review settings November 29, 2025 08:56
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Nov 29, 2025

Walkthrough

Documentation updates to two markdown files where the Example column was removed from Entity Reference tables. The tables now contain only Syntax, MessageEntity Type, and FormattedString Method columns, with all remaining mappings preserved and aligned accordingly.

Changes

Cohort / File(s) Change Summary
Documentation table restructuring
docs/Markdown.md, docs/MarkdownV2.md
Removed Example column from Entity Reference tables; retained Syntax, MessageEntity Type, and FormattedString Method columns with all mappings aligned consistently

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Simple, homogeneous documentation edits (column removal from tables)
  • No logic, configuration, or functional changes involved
  • Consistent pattern applied across both files

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: removing the Example column from entity reference tables in documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/entity-reference-tables

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 78fe9c2 and 58da64b.

📒 Files selected for processing (2)
  • docs/Markdown.md (1 hunks)
  • docs/MarkdownV2.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-29T03:43:25.220Z
Learnt from: CR
Repo: KnightNiwrem/parse-mode PR: 0
File: GEMINI.md:0-0
Timestamp: 2025-11-29T03:43:25.220Z
Learning: Applies to src/format.ts : Use FormattedString fluent API chainable methods for building formatted messages

Applied to files:

  • docs/MarkdownV2.md
🔇 Additional comments (3)
docs/MarkdownV2.md (2)

24-38: Table structure is clean and properly formatted.

The three-column layout (Syntax | MessageEntity Type | FormattedString Method) is consistent and well-aligned. Escaping of pipe characters in the syntax column (lines 30, 38) is correct for Markdown table syntax.


24-38: MarkdownV2.md table format correctly matches HTML.md structure.

The verification confirms that both files use identical three-column markdown table structures:

  • HTML.md: HTML Tag | MessageEntity Type | FormattedString Method
  • MarkdownV2.md: Syntax | MessageEntity Type | FormattedString Method

Both tables maintain the same entity types and method references, with only the first column name appropriately differing based on the format type. The table changes align with the PR objectives.

docs/Markdown.md (1)

29-36: Table structure is consistent with MarkdownV2.md and properly reflects legacy Markdown limitations.

The three-column format aligns well with the MarkdownV2 changes. The reduced row count (6 entities vs. 15 in MarkdownV2) accurately represents the narrower feature set of legacy Markdown. The "Not Supported in Legacy Markdown" section (lines 38–50) effectively clarifies the feature gaps.


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 enhances the documentation by standardizing the format of entity reference tables across Markdown.md and MarkdownV2.md, removing an 'Example' column for better consistency. Additionally, it addresses and fixes a specific rendering error in MarkdownV2.md caused by incorrect markdown escaping, ensuring the tables display correctly.

Highlights

  • Documentation Consistency: The 'Example' column has been removed from entity reference tables in Markdown.md and MarkdownV2.md to ensure consistent formatting with HTML.md.
  • Markdown Table Fix: A broken table in MarkdownV2.md was corrected by properly escaping markdown characters (|| to \|\|) within an expandable blockquote row, resolving a rendering issue.
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

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 removes the 'Example' column from entity reference tables in the Markdown documentation files to maintain consistency with the HTML.md format, and fixes a table rendering issue in MarkdownV2.md.

  • Removed the 'Example' column from entity reference tables in both Markdown.md and MarkdownV2.md
  • Fixed broken table rendering in MarkdownV2.md by correctly escaping pipe characters in the expandable blockquote row
  • Standardized table format across all formatting documentation files

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/MarkdownV2.md Removed Example column from entity reference table and fixed pipe character escaping in expandable blockquote syntax (|| instead of ||)
docs/Markdown.md Removed Example column from entity reference table to match the format used in HTML.md

💡 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 removes the 'Example' column from the entity reference tables in Markdown.md and MarkdownV2.md for consistency with HTML.md. It also correctly escapes a special character in MarkdownV2.md to fix a table rendering issue. The changes are good, but I've pointed out a few minor formatting inconsistencies in MarkdownV2.md where special characters were not properly escaped in the syntax examples.

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

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

Files: docs/Markdown.md, docs/MarkdownV2.md

Checked: Documentation consistency, table formatting, escaping

The changes correctly remove the 'Example' column from entity reference tables to match the format used in HTML.md, and fix the broken table in MarkdownV2.md by properly escaping the expandable blockquote syntax.

Remove template literal examples from the FormattedString Method column
to fix table rendering issues caused by escaped backticks.
@KnightNiwrem KnightNiwrem merged commit f6c99e9 into master Nov 29, 2025
1 check was pending
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 New Issues

Changes since last review look good. The removal of the 'Example' column from entity reference tables in both Markdown.md and MarkdownV2.md successfully matches the format used in HTML.md, and the fix for the expandable blockquote escaping in MarkdownV2.md resolves the table rendering issue.

@KnightNiwrem KnightNiwrem deleted the fix/entity-reference-tables branch November 29, 2025 09:26
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