Skip to content

Fix InstantAsStringAttributeConverter javadoc link to ZonedDateTime converter - #7374

Open
tanvir-ux wants to merge 1 commit into
aws:masterfrom
tanvir-ux:fix-instant-as-string-javadoc-zoned-link
Open

tanvir-ux wants to merge 1 commit into
aws:masterfrom
tanvir-ux:fix-instant-as-string-javadoc-zoned-link

Conversation

@tanvir-ux

Copy link
Copy Markdown

Motivation and Context

InstantAsStringAttributeConverter javadoc says it can read values "with zero offset and without time zone named" written by ZoneOffsetAttributeConverter.

That link is wrong: ZoneOffsetAttributeConverter converts ZoneOffset strings such as +01:00, not zoned date-times. The sibling OffsetDateTimeAsStringAttributeConverter docs correctly point at ZonedDateTimeAsStringAttributeConverter for the same "without a time zone named" case.

Modifications

Update the {@link ...} to ZonedDateTimeAsStringAttributeConverter.

Testing

Docs-only change; verified against OffsetDateTimeAsStringAttributeConverter javadoc wording and the ZoneOffsetAttributeConverter / ZonedDateTimeAsStringAttributeConverter class purposes.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry
  • I confirm that this pull request can be released under the Apache 2 license

@tanvir-ux
tanvir-ux requested a review from a team as a code owner September 15, 2026 01:11
…onverter

The readability note incorrectly linked ZoneOffsetAttributeConverter,
which only converts ZoneOffset values like "+01:00". Sibling converters
(OffsetDateTimeAsStringAttributeConverter) correctly reference
ZonedDateTimeAsStringAttributeConverter for values without a named zone.
@tanvir-ux
tanvir-ux force-pushed the fix-instant-as-string-javadoc-zoned-link branch from fe440b2 to bfec2e7 Compare September 15, 2026 01:11
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.

1 participant