Skip to content

Document Java.Time Instant APIs - #590

Merged
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-java-time-apis-ee6
Aug 18, 2026
Merged

Document Java.Time Instant APIs#590
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-java-time-apis-ee6

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #276

Sources

Validation

  • XML parsing and CRLF-only line-ending checks.
  • 40 distinct Android reference source anchors resolved.
  • Scoped placeholder check: only four managed binding projections remain undocumented.
  • Diff scope and whitespace checks.

Refs #276
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the Java.Time.Instant XML documentation to replace remaining placeholders and align member docs with Android reference content for java.time.Instant.

Changes:

  • Replaced large blocks of “To be added.” placeholders with summaries, parameter/return descriptions, and remarks for many Instant members.
  • Added Android reference links and attribution notices throughout the type and member documentation.
  • Refined remarks for key properties/methods (e.g., Now, OfEpochSecond, ToEpochMilli, truncation/field queries).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment threaddocs/xml/Java.Time/Instant.xml Outdated
Comment threaddocs/xml/Java.Time/Instant.xml Outdated
Comment threaddocs/xml/Java.Time/Instant.xml Outdated
Comment threaddocs/xml/Java.Time/Instant.xml Outdated
Comment threaddocs/xml/Java.Time/Instant.xml Outdated
Comment threaddocs/xml/Java.Time/Instant.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsotoAugust 16, 2026 13:51
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

1 similar comment
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Three Instant documentation defects remain:

  • With(ITemporalAdjuster) includes scraped licensing/footer and “Last updated” text inside the member contract.
  • Both Boolean IsSupported overloads omit their required return-value documentation.
  • Parse(ICharSequence) labels its parameter as string, contradicting the managed Java.Lang.ICharSequence signature.

Please remove the footer, restore both return contracts, and use the correct CharSequence/ICharSequence parameter type.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 309835a7-2ea3-4822-b124-a5b713796f13
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

Addressed the remaining review feedback in 34356d7: removed the scraped footer from With(ITemporalAdjuster), restored both IsSupported return contracts, and corrected the managed parameter labels for both Parse overloads.

@dalexsotodalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The Instant contracts now have correct return documentation, parameter types, source content, ranges, and generated metadata.

@jonathanpeppers
jonathanpeppers merged commit bd3b73b into mainAug 18, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-java-time-apis-ee6 branch August 18, 2026 19:33
Sign up for freeto 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.

3 participants

@jonathanpeppers@dalexsoto