fix: quote the time formats colon :mm: to avoid flag rendering#213
fix: quote the time formats colon :mm: to avoid flag rendering#213timowolf wants to merge 1 commit into
Conversation
The format :mm: is interpreted as a flag when the markdown plugins are available. Quoting \:mm\: helps.
👷 Deploy request for industrial-experience pending review.Visit the deploys page to approve it
|
Summary of ChangesHello, 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 a rendering inconsistency in markdown documentation where time format strings containing colons were being incorrectly parsed as flags by certain markdown plugins. By introducing escape characters before the colons in these time format examples, the change ensures that the documentation renders consistently and accurately across different markdown systems, preventing the need for post-sync fixes. 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. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates the timezones.mdx documentation to escape colons in time format examples (e.g., hh:mm:ss) to address potential rendering issues. The feedback suggests an improvement to use backticks for inline code formatting for these examples, as it is a more idiomatic and robust Markdown approach that enhances readability and prevents special character interpretation.
| <div className="dos" markdown="true"> | ||
|
|
||
| - hh:mm:ss | ||
| - hh\:mm\:ss |
There was a problem hiding this comment.
While escaping the colons fixes the rendering issue, a more idiomatic and robust approach in Markdown is to use backticks for inline code formatting. This clearly designates the string as a format example and prevents any special character interpretation, eliminating the need for manual escaping.
For consistency, you might consider applying this to other format examples throughout the file.
- `hh:mm:ss`
There was a problem hiding this comment.
This is a good idea. I thought about this. However, that would require to change Ann and also the rendering. I think this is not what we want. @tokyojen What do you think. Should we change all formats to the hh:mm:ss writing. That would render the formats a bit different.
| - hh\:mm\:ss.mms | ||
| - hh\:mm\:ss.sss (ISO 8601 standard) |
There was a problem hiding this comment.
@danielleroux Do you know who hh:mm:ss.mms renders in the docs page. Looks like the cleaner solution for the problem
There was a problem hiding this comment.
What exactly do you mean with "who renders"?
The format :mm: is interpreted as a flag when the markdown plugins are available. Quoting :mm: helps.
💡 What is the current behavior?
We use the same source to render the docs in other markdown systems.
Parts of the format hh:mm:ss is rendered as a flag. To avoid fixing it after every
sync, we should also fix it as the source.
🆕 What is the new behavior?
👨💻 Help & support