Platform interface: Updates documentation surrounding location accuracy on Android #1320
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.
On Android, location accuracy is interpreted in a rather unintuitive way. Users of the plugin get confused, resulting in reports coming in where users complain about not receiving positions. The problem sometimes lies in the fact that they use
LocationAccuracy.lowest
. While this accuracy option might suggest that location updates come in quicker, or at least at the same rate as higher accuracy options, this is not the case. Location accuracy on Android is mapped in the following way:This means that when using
LocationAccuracy.lowest
, the update frequency of the position stream becomes 0, unless another app asks for a location update.In the future, we might want to separate the iOS and Android implementations in such a way that the API is not confusing to users in the way that it is now. This is quite the undertaking, however, and therefore we want to start by adding a note in the documentation. This PR adds the note in several locations where users may look during development.
Closes #1315.
Pre-launch Checklist
pubspec.yaml
with an appropriate new version according to the pub versioning philosophy, or this PR is does not need version changes.CHANGELOG.md
to add a description of the change.///
).main
.dart format .
and committed any changes.flutter analyze
and fixed any errors.