Skip to content

Document Android ranging session APIs - #603

Merged
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-android-ranging-apis
Aug 17, 2026
Merged

Document Android ranging session APIs#603
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-android-ranging-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

Sources

Validation

  • Parsed the two edited XML files.
  • Verified CRLF line endings, official Android reference anchors, and that the four scoped public members contain no placeholders.
  • Ran git diff --check.

@dalexsoto please review this focused Android.Ranging documentation update.

Refs #159

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings August 16, 2026 13:56
@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) August 16, 2026 13:56

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 the XML documentation for the Android.Ranging namespace to replace “To be added” placeholders with usable API docs for key session and capability entry points, aligned with the official Android reference pages.

Changes:

  • Documented RangingManager.CreateRangingSession(...) parameters, return value, and behavior.
  • Documented capabilities callback registration/unregistration APIs.
  • Documented RangingSession.Close() and added reference/license attribution blocks.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/xml/Android.Ranging/RangingSession.xml Replaces placeholder docs for Close() with descriptive summary/remarks plus reference/license attribution.
docs/xml/Android.Ranging/RangingManager.xml Replaces placeholder docs for session creation and capabilities callback registration/unregistration with detailed remarks and reference/license attribution.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Android.Ranging/RangingManager.xml
Comment thread docs/xml/Android.Ranging/RangingSession.xml Outdated
Refs #159

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

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

Two ranging-session contracts remain inaccurate:

  • Session creation can return null when a session cannot be created; the managed signature is nullable.
  • Unregistering a capabilities callback cannot cancel callbacks already queued on its executor, so it must not guarantee an immediate callback cutoff.

Please document both the nullable result and possible pending/in-flight callback delivery.

@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto Thank you for the ranging contract corrections. I am applying and validating the nullable session-creation result and the queued-callback behavior before the requested review; the PR retains squash auto-merge.

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

Copilot-Session: 59d8bac3-4d1e-4af6-9b60-b12951db8cec
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto The requested contract corrections are now in a2b0b76: CreateRangingSession documents its nullable failure result, and capabilities callbacks already queued or in progress may still run after unregistration. XML, CRLF, diff, and official Android source-anchor validation passed.

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

Ranging session creation now documents its nullable failure result, and callback unregistration correctly allows queued or in-flight callbacks to complete.

auto-merge was automatically disabled August 17, 2026 21:07

Pull request was closed

@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) August 17, 2026 21:07
@jonathanpeppers
jonathanpeppers merged commit cc0d15b into main Aug 17, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-android-ranging-apis branch August 17, 2026 21:25
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