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

A few minor suggestions for the documentation #1576

Open
rauschma opened this issue Jun 27, 2021 · 1 comment
Open

A few minor suggestions for the documentation #1576

rauschma opened this issue Jun 27, 2021 · 1 comment
Assignees
Labels
documentation Additions to documentation
Milestone

Comments

@rauschma
Copy link
Contributor

rauschma commented Jun 27, 2021

In general, I really like the documentation – it can be quickly scanned yet also offers depth where necessary.

These are a few minor suggestions:

  • “Object Relationship” diagram: The lines don’t seem to be consistent – some nodes have lines to Calendar, others don’t, etc.
  • .toLocaleString(): Are the options fully documented somewhere? (Not in MDN, as far as I can tell.)
  • “Converting between Temporal types and legacy Date”: Explain how to go from Instant and ZonedDateTime to Date?
    • new Date(instant.epochMilliseconds) etc.
  • With some of the type signatures (for methods, etc.), I’d find type definitions useful that are more specific than any.
    • That would probably require separate type definitions, though.
  • “Calendar input element”: Also show how to convert the date picker result to a Temporal value?
  • Section “Key Concepts”: “These extensions are being actively worked on with IETF to get them on a standards track.”
    • AFAICT, this sentence should be moved to bullet point “ISO String Extensions”.
@ptomato ptomato added the documentation Additions to documentation label Jun 28, 2021
@ptomato ptomato added this to the Next milestone Jun 28, 2021
@ptomato
Copy link
Collaborator

ptomato commented Jun 28, 2021

Thanks for the suggestions! I'll get around to these at some point but would welcome any pull requests!

As far as I know, the options of toLocaleString() are documented in MDN: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#parameters We should probably link to that in the docs instead of to the DateTimeFormat page itself.

@ptomato ptomato modified the milestones: Next, Post Stage 4 Dec 8, 2022
@ptomato ptomato self-assigned this Sep 10, 2024
ptomato added a commit that referenced this issue Sep 11, 2024
This example shows how to set properties of an HTML input element using
Temporal objects. For discoverability, link to a later example that shows
how to do the reverse.

See: #1576
ptomato added a commit to gibson042/proposal-temporal that referenced this issue Sep 11, 2024
ptomato added a commit to gibson042/proposal-temporal that referenced this issue Sep 11, 2024
This example shows how to set properties of an HTML input element using
Temporal objects. For discoverability, link to a later example that shows
how to do the reverse.

See: tc39#1576
ptomato added a commit that referenced this issue Sep 19, 2024
This example shows how to set properties of an HTML input element using
Temporal objects. For discoverability, link to a later example that shows
how to do the reverse.

See: #1576
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants