Skip to content

fix: quote the time formats colon :mm: to avoid flag rendering#213

Open
timowolf wants to merge 1 commit into
siemens:mainfrom
timowolf:docs/quote-time-format
Open

fix: quote the time formats colon :mm: to avoid flag rendering#213
timowolf wants to merge 1 commit into
siemens:mainfrom
timowolf:docs/quote-time-format

Conversation

@timowolf
Copy link
Copy Markdown
Member

@timowolf timowolf commented Mar 26, 2026

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.

Screenshot 2026-03-26 at 13 52 25

🆕 What is the new behavior?

  • Quoting the colo : makes sue to keep it.

👨‍💻 Help & support

The format :mm: is interpreted as a flag when the markdown plugins are available.
Quoting \:mm\: helps.
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 26, 2026

👷 Deploy request for industrial-experience pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit b55ed70

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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

  • Markdown Rendering Fix: Escaped colons in time format examples (e.g., hh:mm:ss to hh:mm:ss) within the documentation to prevent them from being misinterpreted as flags by markdown plugins.
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.

Footnotes

  1. 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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a 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 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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`

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +53 to +54
- hh\:mm\:ss.mms
- hh\:mm\:ss.sss (ISO 8601 standard)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similarly, using backticks for inline code formatting is the preferred method for representing these format strings. It improves readability and is less error-prone than manual character escaping.

- `hh:mm:ss.mms`
- `hh:mm:ss.sss` (ISO 8601 standard)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danielleroux Do you know who hh:mm:ss.mms renders in the docs page. Looks like the cleaner solution for the problem

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What exactly do you mean with "who renders"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants