docs: remove examples column from entity reference tables#13
docs: remove examples column from entity reference tables#13KnightNiwrem merged 2 commits intomasterfrom
Conversation
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).
WalkthroughDocumentation 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🧰 Additional context used🧠 Learnings (1)📚 Learning: 2025-11-29T03:43:25.220ZApplied to files:
🔇 Additional comments (3)
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 enhances the documentation by standardizing the format of entity reference tables across 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 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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
✅ 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.
There was a problem hiding this comment.
✅ 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.
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
✏️ Tip: You can customize this high-level summary in your review settings.