Skip to content

Document Android location accuracy requirements - #636

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-android-location-apis
Open

Document Android location accuracy requirements#636
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-android-location-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Document the five missing Android.Locations.Accuracy values mapped from android.location.Criteria.
  • Preserve the existing Android Open Source Project attribution in each member entry.

Sources

  • AOSP Criteria.java (ACCURACY_COARSE, ACCURACY_FINE, ACCURACY_HIGH, ACCURACY_LOW, and NO_REQUIREMENT)

Validation

  • Parsed docs/xml/Android.Locations/Accuracy.xml as XML.
  • Confirmed CRLF-only line endings and a focused, whitespace-clean diff.

Refs #104

Refs #104

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 updates the API reference XML for Android.Locations.Accuracy to replace placeholder member documentation with descriptions aligned to android.location.Criteria accuracy requirement constants, while keeping the AOSP attribution paragraphs in each member entry.

Changes:

  • Replaced To be added. placeholders with summaries for Coarse, Fine, High, Low, and NoRequirement.
  • Kept the existing Android Open Source Project / CC BY 2.5 attribution block for each updated member.
Suppressed comments (2)

docs/xml/Android.Locations/Accuracy.xml:68

  • “location-accuracy” is an uncommon/awkward compound here and doesn’t match typical wording elsewhere in the docs. Prefer “location accuracy” without the hyphen.
        <summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">Indicates a fine location-accuracy requirement.</summary>

docs/xml/Android.Locations/Accuracy.xml:125

  • This summary contains multiple sentences (and is flagged TrimmedButTooLong). To keep concise (first sentence) and improve readability, move the extra detail into as a separate .
        <summary ToolPath="TrimmedButTooLong" tool="FirstSentenceInJavadocToMdoc">Indicates a low location-accuracy requirement. It may be used for horizontal, altitude, speed, or bearing accuracy. For horizontal and vertical position, it corresponds roughly to an accuracy greater than 500 meters.</summary>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </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/Android.Locations/Accuracy.xml Outdated
Comment thread docs/xml/Android.Locations/Accuracy.xml Outdated
Comment thread docs/xml/Android.Locations/Accuracy.xml Outdated
Refs #104

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@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.

2 participants