Skip to content
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

Use iso8601 datetime format in docs site #395

Open
scarf005 opened this issue Aug 22, 2024 · 0 comments
Open

Use iso8601 datetime format in docs site #395

scarf005 opened this issue Aug 22, 2024 · 0 comments

Comments

@scarf005
Copy link

scarf005 commented Aug 22, 2024

Is your feature request related to a problem? Please describe.

  1. the metals docs site use multiple time formats, which is inconsistent.
DD MM YYYY MM DD YYYY YYYY-MM-DD
image image image
  1. due to date formatter using local datetime format, locally served sites will render differently formatted time string. this can be workaround via setting timezone but still is inconvenient.

https://github.com/scalameta/metals/blob/3f04322dcc572ca167a6e428eab633542cbe7a3b/metals-docs/src/main/scala/docs/Snapshot.scala#L19-L24

image

(this is malformed, the 'human-readable' datetime format in korea would be 2024년 8월 23일 00:15)

Describe the solution you'd like

Change date formatter to use iso8601 (YYYY-MM-DD) or RFC 3339 (for 'human readable' ) time format, as it's unambiguous, easy to sort and recognized worldwide. it's already used on releases.

I'm willing to open a PR. Check scalameta/metals@main...scarf005:metals:docs/use-iso8601 for proposed solution.

Describe alternatives you've considered

keeping the date format as-is.

Additional context

most asian countries use YMD datetime format by default.

Search terms

date, time, datetime, human-readable format, iso8601

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

No branches or pull requests

1 participant