Skip to content

Document TemporalField unit properties - #498

Open
jonathanpeppers wants to merge 3 commits into
mainfrom
jonathanpeppers-document-java-temporal-apis-2b6
Open

Document TemporalField unit properties#498
jonathanpeppers wants to merge 3 commits into
mainfrom
jonathanpeppers-document-java-temporal-apis-2b6

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Document ITemporalField.BaseUnit, IsDateBased, IsTimeBased, and RangeUnit from Java TemporalField contract documentation.

Refs #267

Sources

Validation

  • Parsed docs/xml/Java.Time.Temporal/ITemporalField.xml as XML.
  • Confirmed zero To be added. placeholders remain in the scoped file.
  • Confirmed CRLF line endings, git diff --check, and no index.xml or namespace-index changes.

Refs #267

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

This PR fills in missing XML documentation for key Java.Time.Temporal.ITemporalField unit-related members by translating the Java TemporalField contract docs into the generated .NET XML doc format.

Changes:

  • Documented BaseUnit semantics and added a link to the corresponding Java reference.
  • Documented IsDateBased and IsTimeBased contract behavior (including derivation notes) with reference links.
  • Documented RangeUnit semantics with reference link and expanded remarks.

💡 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.Temporal/ITemporalField.xml Outdated
Refs #267

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@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.Temporal/ITemporalField.xml: the IsDateBased and IsTimeBased remarks expose raw JavaDoc tokens (ChronoField#EPOCH_DAY EPOCH_DAY and ChronoField#NANO_OF_DAY NANO_OF_DAY) instead of managed API references. Please replace them with <see cref="P:Java.Time.Temporal.ChronoField.EpochDay" /> and <see cref="P:Java.Time.Temporal.ChronoField.NanoOfDay" />.

Refs #267

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

@jonathanpeppers jonathanpeppers left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Addressed the requested correction: IsDateBased and IsTimeBased now use the managed ChronoField.EpochDay and ChronoField.NanoOfDay API references.

@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

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