Baseflow / Baseflow/flutter-geolocator
[Enhancement proposal]: LocationAccuracyStatus dartdocs out of date
- Dominant language
- Dart
- Stars
- 1.3k
- Forks
- 803
- Avg merge
- 8h 16m
- Merged PRs (30d)
- 1
Description
### Please check the following before submitting a new issue.
- [X] I have searched the [existing issues](https://github.com/baseflow/flutter-geolocator/issues).
- [X] I have carefully [read the documentation](https://github.com/baseflow/flutter-geolocator/blob/main/geolocator/README.md) and verified I have added the required platform specific configuration.
### Please select affected platform(s)
- [X] Android
- [ ] iOS
- [ ] Linux
- [ ] macOS
- [ ] Web
- [ ] Windows
### Proposal
https://pub.dev/packages/geolocator#:~:text=Location%20accuracy%20(Android%20and%20iOS%2014%2B%20only)
Here in README we can read that the `Geolocator().getLocationAccuracy()` works for Android, but in the Dartdocs of the `LocationAccuracyStatus` say:
https://github.com/Baseflow/flutter-geolocator/blob/026534d34d56226d51b348ed46397055520c1e7f/geolocator_platform_interface/lib/src/enums/location_accuracy_status.dart#L9-L11
### Pitch
This will make the code documentation more up-to-date and not misguiding.
Contributor guide
Research direction
Open geolocator_platform_interface/lib/src/enums/location_accuracy_status.dart and compare its LocationAccuracyStatus Dartdocs with the Android support described in the linked README. Update the documentation so it no longer misleads readers about Android support, then review the rendered API documentation for accuracy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android, dart
- Domain
- documentation, mobile-dev
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100