Skip to content

Document core Android.Text.Method transformations - #481

Open
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-document-android-text-method
Open

Document core Android.Text.Method transformations#481
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-document-android-text-method

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Sources

Validation

  • Parsed both changed XML files with PowerShell's XML parser.
  • Confirmed CRLF-only line endings in both changed files.
  • Ran git diff --check.

Refs #205

Refs #205

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 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 for GetOriginal() in SingleLineTransformationMethod and HideReturnsTransformationMethod.
  • Filled <returns> docs for GetReplacement() in SingleLineTransformationMethod and HideReturnsTransformationMethod.

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

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

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