Document core Android.Text.Method transformations - #481
Open
jonathanpeppers wants to merge 1 commit into
Open
Conversation
Refs #205 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 20:49
jonathanpeppers
enabled auto-merge (squash)
August 14, 2026 20:49
There was a problem hiding this comment.
Pull request overview
Updates Android API XML documentation in Android.Text.Method to replace “To be added.” placeholders with meaningful <returns> documentation for core transformation methods (per #205).
Changes:
- Filled
<returns>docs forGetOriginal()inSingleLineTransformationMethodandHideReturnsTransformationMethod. - Filled
<returns>docs forGetReplacement()inSingleLineTransformationMethodandHideReturnsTransformationMethod.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/xml/Android.Text.Method/SingleLineTransformationMethod.xml | Replaces placeholder <returns> docs for GetOriginal()/GetReplacement() with descriptive text. |
| docs/xml/Android.Text.Method/HideReturnsTransformationMethod.xml | Replaces placeholder <returns> docs for GetOriginal()/GetReplacement() with descriptive text. |
Suppressed comments (2)
docs/xml/Android.Text.Method/HideReturnsTransformationMethod.xml:155
- The text should describe the method's return value (a char array) instead of restating the summary; make it explicit that this returns the replacement character.
<returns>The character that \r is replaced with is \uFEFF.</returns>
docs/xml/Android.Text.Method/SingleLineTransformationMethod.xml:156
- The summary/remarks/returns contain grammatical errors ("replaced with is") and the should describe the returned char[]; update these lines so they clearly describe the replacement characters and use a consistent U+FEFF representation.
<summary>The character \n is replaced with is space;
the character \r is replaced with is FEFF (zero width space).</summary>
<returns>The character \n is replaced with space; the character \r is replaced with FEFF (zero width space).</returns>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| <Docs> | ||
| <summary>The characters to be replaced are \n and \r.</summary> | ||
| <returns>To be added.</returns> | ||
| <returns>The characters to be replaced are \n and \r.</returns> |
| <Docs> | ||
| <summary>The character to be replaced is \r.</summary> | ||
| <returns>To be added.</returns> | ||
| <returns>The character to be replaced is \r.</returns> |
Member
Author
|
@dalexsoto review |
dalexsoto
approved these changes
Aug 15, 2026
dalexsoto
left a comment
Member
There was a problem hiding this comment.
The documented API behavior matches the current contracts; no blocking issues found.
auto-merge was automatically disabled
August 15, 2026 02:22
Pull Request is not mergeable
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.
Sources
Validation
Refs #205