Fix/suggested edits markup appears in rendered text #620
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @marius-refinq, 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!
Summary of Changes
This pull request addresses an issue where the "Suggest Edits" feature in Notion was causing suggestion markup to appear in the rendered text when using react-notion-x. The changes introduce a fix to hide or filter out this markup, improving readability. The PR modifies packages/notion-types/src/core.ts to include SuggestionEditFormat as a valid format type, and updates packages/react-notion-x/src/components/text.tsx to handle the si case by returning null, effectively hiding the suggestion edit markup.
Highlights
- Bug Fix: Fixes an issue where Notion's "Suggest Edits" markup was visible in rendered text.
- Readability Improvement: Hides suggestion edit markup to enhance the readability of rendered Notion content.
- Type Definition Update: Adds
SuggestionEditFormatto the list of valid format types innotion-types. - Component Update: Updates the
Textcomponent inreact-notion-xto handle and hide suggestion edit markup.
Changelog
- packages/notion-types/src/core.ts
- Added
SuggestionEditFormattype definition. - Included
SuggestionEditFormatin theSubDecorationtype.
- Added
- packages/react-notion-x/src/components/text.tsx
- Added a case to handle
SuggestionEditFormat('si') by returning null, effectively hiding the markup.
- Added a case to handle
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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.
Trivia time!
What company developed the original Notion application?
Click here for the answer
Notion Labs Inc. developed the original Notion application.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request addresses an issue where Notion's "Suggest Edits" feature was causing suggestion markup to appear in the rendered text. The changes effectively hide or filter out this markup, improving readability. The approach taken seems reasonable and directly addresses the problem described.
Summary of Findings
- Missing exhaustive switch case: The
Textcomponent'sswitchstatement inpackages/react-notion-x/src/components/text.tsxcould benefit from a default return value to handle unexpected decorator types more gracefully. While the current implementation logs an error in development, providing a fallback return value would enhance robustness.
Merge Readiness
The pull request effectively resolves the issue of suggestion markup appearing in rendered text. The changes are straightforward and address the problem directly. While the addition of a default return value in the switch statement within the Text component is suggested for enhanced robustness, the current implementation is functional. I am unable to approve the pull request, and other reviewers should review and approve this code before merging. I recommend merging this pull request after considering the suggestion.
|
Thanks @marius-refinq 🙏 |
Description
Description
Notion’s new "Suggest Edits" feature now causes suggestion markup to appear in the rendered text by react-notion-x, which affects readability. The markup should be hidden or filtered out.
Before the fix:
After the fix
Notion Test Page ID