fix: quote the time formats colon :mm: to avoid flag rendering #213
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,7 +35,7 @@ Use colons (:) to split times between hours, minutes, and seconds. | |
| <div className="dos-and-donts" markdown="true"> | ||
| <div className="dos" markdown="true"> | ||
|
|
||
| - hh\:mm\:ss | ||
|
|
||
| </div> | ||
| <div className="donts" markdown="true"> | ||
|
|
@@ -50,8 +50,8 @@ Use periods (.) to add milliseconds and nanoseconds, not a colon (:) according t | |
| <div className="dos-and-donts" markdown="true"> | ||
| <div className="dos" markdown="true"> | ||
|
|
||
| - hh\:mm\:ss.mms | ||
| - hh\:mm\:ss.sss (ISO 8601 standard) | ||
|
Comment on lines
+53
to
+54
Contributor
There was a problem hiding this comment. 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.
Member
Author
There was a problem hiding this comment. @danielleroux Do you know who
Collaborator
There was a problem hiding this comment. What exactly do you mean with "who renders"? |
||
| - 0:00:00.920 | ||
|
|
||
| </div> | ||
|
|
@@ -279,4 +279,4 @@ Use "recent" for past events that have just happened. | |
|
|
||
| - [Dates](./date.mdx) | ||
| - [Time picker](../../../components/time-picker/index.mdx) | ||
| - [CLDR set of time zones (external link)](https://cldr.unicode.org/translation/time-zones-and-city-names) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 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.
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.
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:sswriting. That would render the formats a bit different.