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

feat: update docs Date fields to link to the RFC3339 spec #181

Merged
merged 3 commits into from Feb 22, 2024

Conversation

jasonbahl
Copy link
Contributor

What does this implement/fix? Explain your changes.

This updates the GraphQL field descriptions for fields of the DatePicker and DateTimePicker ACF field type to indicate that the strings returned will be formatted in RFC3339 format.

This is helpful for client developers to know how they can expect to interact with the resulting value.

Does this close any currently open issues?

closes #161

Any other comments?

In the WPGraphQL IDE we can see the field descriptions now include a link to the RFC3339 spec and a description that the field will return according to that spec.
CleanShot 2024-02-21 at 15 03 27

CleanShot 2024-02-21 at 14 53 50

CleanShot 2024-02-21 at 15 03 36

…ster_graphql_acf_field_type`, allowing for a string or callback to be passed that will append a string to the description which is populated by the field graphql_description or instructions field.

- implements this on the DatePicker and DateTimePicker field types to show that the string will be output in RFC3339 format
- updates the description of the startDate and endDate fields of the ACFE_Date_Range type to include a link to the RFC3339 spec
@jasonbahl jasonbahl self-assigned this Feb 21, 2024
…contain a string but might not equal it exactly
- add translators: comments
Copy link
Member

@josephfusco josephfusco left a comment

Choose a reason for hiding this comment

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

Link looks good!

@jasonbahl jasonbahl merged commit 2ed5e0c into develop Feb 22, 2024
25 checks passed
@jasonbahl jasonbahl mentioned this pull request Mar 15, 2024
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.

Date and Datetime field types should mention RFC3339 format in field description
2 participants