docs(sensor_plus): improve description of accelerometer #1425
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.
Description
I believe the description of the accelerometer in docs/sensors_plus/usage.mdx is not accurate.
I changed the description of AccelerometerEvent and UserAccelerometerEvent. See https://en.wikipedia.org/wiki/Accelerometer
The text is now rather long; I was unable to compress the information I find relevant in a shorter text.
I changed the order of the topics because I feel the presentation is more clear if we explain first the concept of acceleration in itself, and only after that we explain that the gravity is indistinguishable from an accelerated movement. I also changed the order in packages/sensors_plus/sensors_plus/example/lib/main.dart (perhaps this wasn't necessary).
I wonder if the descriptions of GyroscopeEvent and MagnetometerEvent are accurate and complete. I think at least the physical measure units should be mentioned. I suspect the GyroscopeEvent describes the rate of change of the rotation (angular velocity) rather than the rotation of the device. Or perhaps the angular acceleration ? Since I don't have enough knowledge on these topics, I left them unchanged.
Related Issues
Discussion #1419
Checklist
CHANGELOG.md
nor thepubspec.yaml
files.flutter analyze
) does not report any problems on my PR.Breaking Change
Does your PR require plugin users to manually update their apps to accommodate your change?
!
in the title as explained in Conventional Commits).