-
Notifications
You must be signed in to change notification settings - Fork 0
STNDP-116 Line break is not working #110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @hyokualexkwon, 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 an issue where line breaks were not being correctly interpreted and rendered in markdown content. By pre-processing the input text to explicitly convert single newlines into hard breaks, the system now ensures that displayed content respects intended line breaks, making it more readable and consistent with user expectations, especially for users who might not explicitly use markdown's double-space for line breaks.
Highlights
- Markdown Rendering Fix: Implemented a fix in the
parseMarkdownToHtmlfunction to correctly render line breaks in markdown by converting single newlines into hard breaks, improving user experience for those less familiar with markdown syntax.
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
-
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.
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 attempts to make single newlines create hard breaks in the final HTML, which is a common UX improvement. However, the current implementation using text.replace(/\n/g, ' \n') is a bit too aggressive and will cause problems with Markdown constructs like code blocks, where it will add unwanted trailing whitespace. My review provides details on these side effects and suggests exploring a more robust, context-aware solution, like a dedicated Markdown extension.
| // Convert single newlines to hard breaks (better UX for non-markdown users) | ||
| const processedText = text.replace(/\n/g, ' \n'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While converting single newlines to hard breaks improves the experience for users unfamiliar with Markdown, this global replacement will negatively affect code blocks. It will add trailing whitespace to every line within a fenced (```) or indented code block, which can alter formatting and is generally considered bad practice.
For example, this code block:
```javascript
// This line in a code block
const x = 1;
```...will be processed into this before parsing, adding trailing spaces:
```javascript
// This line in a code block
const x = 1;
``` This can also cause unintended layout changes in lists and blockquotes by adding <br> tags where they aren't expected.
A more robust solution would be to use a micromark extension that handles this, or a higher-level library like remark with the remark-breaks plugin, which can apply this logic without affecting code blocks.
No description provided.