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

Improve description of LocalDate #7636

Open
cmeeren opened this issue Oct 21, 2024 · 0 comments
Open

Improve description of LocalDate #7636

cmeeren opened this issue Oct 21, 2024 · 0 comments

Comments

@cmeeren
Copy link
Contributor

cmeeren commented Oct 21, 2024

Product

Hot Chocolate

Is your feature request related to a problem?

The LocalDate scalar (presumably from HotChocolate.Types.NodaTime) has this description in the GraphQL schema:

LocalDate is an immutable struct representing a date within the calendar, with no reference to a particular time zone or time of day.

It doesn't make sense to refer to things like "immutable" or "struct" for GraphQL types.

The solution you'd like

Change the description so it makes sense from a GraphQL perspective. For example:

LocalDate is a String-based scalar with the format YYYY-MM-DD that represents a date within the calendar, with no reference to a particular time zone or time of day.

Note that this may apply to other NodaTime scalars, too (I haven't checked).

@cmeeren cmeeren added the 🎉 enhancement New feature or request label Oct 21, 2024
@glen-84 glen-84 removed the 🎉 enhancement New feature or request label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants