Skip to content

Document ZoneRules query APIs - #485

Open
jonathanpeppers wants to merge 3 commits into
mainfrom
jonathanpeppers-document-java-time-zone
Open

Document ZoneRules query APIs#485
jonathanpeppers wants to merge 3 commits into
mainfrom
jonathanpeppers-document-java-time-zone

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Sources

Validation

  • Parsed docs/xml/Java.Time.Zone/ZoneRules.xml as XML.
  • Confirmed CRLF line endings and git diff --check.
  • Confirmed no To be added. placeholders remain in the documented ZoneRules core query and transition members.

Refs #306

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

Copilot AI 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 generated XML documentation for Java.Time.Zone.ZoneRules to replace placeholder text with real API documentation, supporting the broader effort in #306 to eliminate To be added. entries in the Java.Time.Zone namespace.

Changes:

  • Replaced To be added. placeholders with parameter/summary/returns documentation for key ZoneRules query APIs (offsets, transitions, daylight savings).
  • Added clearer return-value wording (e.g., nullability behavior) for several query members.

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

Comment thread docs/xml/Java.Time.Zone/ZoneRules.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 14, 2026 21:10
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto 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.

docs/xml/Java.Time.Zone/ZoneRules.xml: both ZoneRules.Of overloads omit that their arguments must be non-null, and the five-argument overload also omits the enforced maximum of 16 entries in lastRules. Please document the non-null requirements, the 16-rule limit, and the corresponding NullPointerException/IllegalArgumentException behavior.

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

Copy link
Copy Markdown
Member Author

@dalexsoto Addressed in e4b3a1c: both \ZoneRules.Of\ overloads now state their non-null requirements, and the five-argument overload documents the 16-entry \lastRules\ limit plus the corresponding \NullPointerException\ and \IllegalArgumentException\ behavior.

@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 15, 2026 14:33
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.

3 participants