Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(sensor_plus): improve description of accelerometer #1425

Merged
merged 4 commits into from
Apr 5, 2023

Conversation

cristian-barbarosie
Copy link
Contributor

@cristian-barbarosie cristian-barbarosie commented Dec 29, 2022

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

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I titled the PR using Conventional Commits.
  • I did not modify the CHANGELOG.md nor the pubspec.yaml files.
  • All existing and new tests are passing.
  • The analyzer (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?

  • Yes, this is a breaking change (please indicate that with a ! in the title as explained in Conventional Commits).
  • No, this is not a breaking change.

@nohli nohli requested a review from mhadaily March 5, 2023 11:05
Copy link
Member

@nohli nohli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
Thanks for your contribution! ❤️

@nohli nohli merged commit 1af73a6 into fluttercommunity:main Apr 5, 2023
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