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

Improve documentation #225

Open
gopelkujo opened this issue Oct 3, 2024 · 2 comments · May be fixed by #226
Open

Improve documentation #225

gopelkujo opened this issue Oct 3, 2024 · 2 comments · May be fixed by #226

Comments

@gopelkujo
Copy link

I found this question in Stackoverflow. Then i realize that in this package documentation, there's a miss sequence of how user implement this package in their project. And this most likely lead the user thinks there is a problem even though the user has not completed all the steps.

In the Stackoverflow question, there's user that has a problem with this package debug in iOS, i see the error is:

*** Assertion failure in -[CLLocationManager setAllowsBackgroundLocationUpdates:], CLLocationManager.m:972

*** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'Invalid parameter not satisfying: !stayUp || CLClientIsBackgroundable(internal->fClient) || _CFMZEnabled()'

So it means the user has not added the key to info.plist as a permission for iOS even though it is mentioned in the last section of documentation.

In this example, as the permission is very important to make sure this package running well, i suggest to move the permission section documentation to the first step to start.

Actually it's fine as long as the documentation mentioned it, but i guess it's much better if we can minimize the unnecessary errors.

If the maintainer don't mind i'd like to contribute create a pr about this one:)

@MoralCode
Copy link
Collaborator

I'd be happy to help merge a docs fix to address this, Thanks for reaching out!

@gopelkujo
Copy link
Author

Thanks for your quick response! i'll request a pr as soon as i can.

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 a pull request may close this issue.

2 participants