Document ZoneRules query APIs - #485
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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 keyZoneRulesquery 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.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
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>
|
@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. |
Sources
Validation
docs/xml/Java.Time.Zone/ZoneRules.xmlas XML.git diff --check.To be added.placeholders remain in the documented ZoneRules core query and transition members.Refs #306