Improve request
method documentation
#726
Merged
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.
Summary
The
request
method takes an optionalrationale
parameter.This parameter is read on Android only:
react-native-permissions/src/methods.android.ts
Line 36 in 6cd97d5
It is not read on iOS:
react-native-permissions/src/methods.ios.ts
Line 41 in 6cd97d5
Neither Windows:
react-native-permissions/src/methods.windows.ts
Line 26 in 6cd97d5
This PR tweaks the documentation to make it clear that the
Rationale
is only useful on Android.Happy to tweak the wording if needed.
Test Plan
No test plan, see updated
README
.What's required for testing (prerequisites)?
What are the steps to test it (after prerequisites)?
Compatibility
Checklist
README.md
example/App.tsx
)