Document Android.Text.Format constants - #488
Open
jonathanpeppers wants to merge 2 commits into
Open
Conversation
Refs #199 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and
a lite review from Copilot
August 14, 2026 21:01
jonathanpeppers
enabled auto-merge (squash)
August 14, 2026 21:02
There was a problem hiding this comment.
Pull request overview
This PR improves API reference documentation in the Android.Text.Format namespace by replacing placeholder text with concrete descriptions for TimeFormatValues, DayOfWeek, and DateFormat.GetDateFormatOrder, aligning the docs more closely with the underlying Android/AOSP surface.
Changes:
- Documented
TimeFormatValuesfield-selector constants with specific summaries. - Documented
DayOfWeekenum values with day-name summaries and updated the type summary. - Completed the
contextparameter and return documentation forDateFormat.GetDateFormatOrder.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/xml/Android.Text.Format/TimeFormatValues.xml | Replaces “To be added” placeholders with descriptions for the field selector enum used by Time.GetActualMaximum. |
| docs/xml/Android.Text.Format/DayOfWeek.xml | Documents weekday enum values and updates the type summary for DayOfWeek. |
| docs/xml/Android.Text.Format/DateFormat.xml | Adds parameter/return docs for GetDateFormatOrder(Context). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Refs #199 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Member
Author
|
@dalexsoto review |
dalexsoto
requested changes
Aug 15, 2026
dalexsoto
left a comment
Member
There was a problem hiding this comment.
Two public API descriptions are incorrect:
docs/xml/Android.Text.Format/DayOfWeek.xml: the type summary says every value is a day of the week, butMondayBeforeJulianEpochis the Julian day number 2440585. Please generalize the summary.docs/xml/Android.Text.Format/TimeFormatValues.xml: the type summary andWeekNumdescription implyWeekNumworks withTime.GetActualMaximum, but AOSP throwsRuntimeException("WEEK_NUM not implemented")for that value. Please document it as unsupported and qualify the type summary.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
TimeFormatValuesselectors andDayOfWeekvalues from the AOSPTimeAPI surface.DateFormat.GetDateFormatOrder.Refs #199
Sources
Validation
git diff --check.