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][sensors] Add note regarding running watchStepCount in background #28798

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

behenate
Copy link
Member

Why

We should make the limitations of the Pedometer API clearer in the docs

ENG-11584

Copy link
Member

@amandeepmittal amandeepmittal left a comment

Choose a reason for hiding this comment

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

Lgtm 👍

Left a small suggestion.

packages/expo-sensors/src/Pedometer.ts Outdated Show resolved Hide resolved
@behenate behenate force-pushed the @behenate/add-pedometer-note branch from 37f0c41 to 1a96960 Compare May 21, 2024 14:11
@expo-bot
Copy link
Collaborator

Hi there! 👋 I'm a bot whose goal is to ensure your contributions meet our guidelines.

I've found some issues in your pull request that should be addressed (click on them for more details) 👇

⚠️ Suggestion: Missing changelog entries


Your changes should be noted in the changelog. Read Updating Changelogs guide and consider adding an appropriate entry to the following changelogs:


Generated by ExpoBot 🤖 against 1a96960

@@ -28,6 +28,10 @@ export type PedometerUpdateCallback = (result: PedometerResult) => void;
* provided with a single argument that is [`PedometerResult`](#pedometerresult).
* @return Returns a [`Subscription`](#subscription) that enables you to call
* `remove()` when you would like to unsubscribe the listener.
*
* > Pedometer updates will not be delivered while the app is in the background. As an alternative, on Android, use another solution based on
* > [`Health Connect API`](https://developers.google.com/fit) or [`Google Fit API`](https://developer.android.com/health-and-fitness/guides/health-connect).
Copy link
Contributor

Choose a reason for hiding this comment

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

@behenate The links are switched up - it should be the other way around. Also, it might be worth not recommending Google Fit API because as of right now, it is not even possible to sign up for the API (it is deprecated)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants