-
Notifications
You must be signed in to change notification settings - Fork 214
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
Highlighting multi-line comments #2150
Conversation
WalkthroughWalkthroughThe changes introduce JavaScript logic and CSS styles to highlight comments in code blocks within the Changes
Assessment against linked issues
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
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.
Actionable comments posted: 2
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.
Actionable comments posted: 2
It seems that on initial load, the highlighting works, but switching to other files breaks the highlighting (the file will revert back to broken highlighting highlighting-broke.mov |
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.
Actionable comments posted: 1
Discussed offline that this PR still has some issues with highlighting, so needs a second attempt / revision. |
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.
Actionable comments posted: 3
Updated highlighting code highlights code even if we change files. Highlighting code also takes into account keywords such as "#include', previously these were flagged out as comments. To check that it works as expected, check that the output is the same as that in: https://highlightjs.org/demo |
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.
Actionable comments posted: 1
Outside diff range and nitpick comments (1)
app/views/submissions/view.html.erb (1)
126-131
: Ensure accessibility and usability in UI elements.The navigation buttons and download link could benefit from improved accessibility features. Consider adding
aria-label
attributes to provide better context for screen readers. For example:<a href="<%= download_file_url(@submission) %>" class="btn small" title="Download" aria-label="Download submission">Download</a> <button class="btn small" onclick="resetLayout()" aria-label="Reset layout of the page">Reset Layout</button>Adding these attributes helps users with screen readers understand the function of these buttons without needing to rely solely on visual cues.
Fixes #1732.
Before, multi-line comments were not highlighted:
With this change:
How Has This Been Tested?
Types of changes
Checklist:
overcommit --install && overcommit --sign
to use pre-commit hook for linting