Skip to content

Commit cfd7b42

Browse files
authored
docs: readability updates (#77)
1 parent b11d928 commit cfd7b42

21 files changed

+2457
-2174
lines changed

.yarn/releases/yarn-4.7.0.cjs

Lines changed: 0 additions & 935 deletions
This file was deleted.

.yarn/releases/yarn-4.9.2.cjs

Lines changed: 942 additions & 0 deletions
Large diffs are not rendered by default.

.yarnrc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
nodeLinker: node-modules
22

3-
yarnPath: .yarn/releases/yarn-4.7.0.cjs
3+
yarnPath: .yarn/releases/yarn-4.9.2.cjs

babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/buttons/google-logo-button.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_class_name: sponsor-heart
44

55
# GoogleLogoButton
66

7-
A Google Sign-In button that follows Google's official branding guidelines. Intended for native apps.
7+
A Google Sign-In button that follows Google's official branding guidelines. Intended for native apps. It renders null when used on the web.
88

99
import Banner from '../_sponsorBanner.mdx';
1010

docs/buttons/web.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ As the Universal sign in Guide explains, there are two ways to sign in on the we
1919

2020
One-tap UI may not always be available: This happens if user has [opted out](https://developers.google.com/identity/gsi/web/guides/features#globally_opt_out) or when they close the dialog several times in a row, entering the [cooldown period](https://developers.google.com/identity/gsi/web/guides/features#exponential_cooldown).
2121

22-
The Google Sign-In button serves as a fallback. Tapping it will open the regular Google Sign-In dialog.
22+
The Google Sign-In button serves as a fallback. Tapping it opens the regular Google Sign-In dialog.
2323

2424
```tsx
2525
import { WebGoogleSigninButton } from '@react-native-google-signin/google-signin';

docs/errors.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ try {
3636
import { statusCodes } from '@react-native-google-signin/google-signin';
3737
```
3838

39-
Status codes are useful when determining which kind of error has occurred during the sign-in process. Under the hood, these constants are derived from native GoogleSignIn error codes and are platform-specific. Always compare `error.code` to `statusCodes.*` and do not rely on the raw value of `error.code`.
39+
Status codes are useful when determining which kind of error has occurred during the sign-in process. Under the hood, these constants are derived from native error codes and are platform-specific. Always compare `error.code` to `statusCodes.*` and do not rely on the raw value of `error.code`.
4040

4141
See [example usage](one-tap#signin).
4242

43-
| Name | Description |
44-
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
45-
| `IN_PROGRESS` | Trying to invoke another operation (e.g. `signInSilently`) when previous one has not yet finished. If you call e.g. `signInSilently` twice, two calls to `signInSilently` in the native module will be done. The promise from the first call to `signInSilently` will be rejected with this error, and the second will resolve / reject with the result of the native call. |
46-
| `PLAY_SERVICES_NOT_AVAILABLE` | Play services are not available or outdated. This happens on Android, or on the web when you're calling the exposed APIs [before the Client library is loaded](setting-up/web). |
43+
| Name | Description |
44+
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
45+
| `IN_PROGRESS` | Trying to invoke another operation (e.g. `signInSilently`) when previous one has not yet finished. If you call e.g. `signInSilently` twice, two calls to `signInSilently` in the native module are done. The promise from the first call to `signInSilently` will be rejected with this error, and the second will resolve / reject with the result of the native call. |
46+
| `PLAY_SERVICES_NOT_AVAILABLE` | Play services are not available or outdated. This happens on Android, or on the web when you're calling the exposed APIs [before the Client library is loaded](setting-up/web). |
4747

4848
### Status codes specific to Universal sign in {#universal-status-codes}
4949

docs/install.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Why paid? According to the [State of React Native Survey](https://results.2024.s
1515
⭐️ **Key Features**:
1616

1717
- **Cross-Platform**: Unified APIs which work on **Android**, **iOS**, **Web**, and **macOS**.
18-
1918
- Android: Built with [Credential Manager library](https://developers.google.com/identity/android-credential-manager)
2019
- Web: Uses [Sign In with Google for Web](https://developers.google.com/identity/gsi/web/guides/features)
2120
- iOS & macOS: Powered by the [Google Sign-In SDK](https://developers.google.com/identity/sign-in/ios/start)

docs/integration-notes.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 55
2+
sidebar_position: 61
33
---
44

55
# Integration notes
@@ -18,6 +18,7 @@ sidebar_position: 55
1818

1919
The default requested scopes are `email` and `profile`.
2020

21-
If you want to manage other data from your application (for example access user agenda or upload a file to drive) you need to request additional permissions. This can be accomplished by adding the necessary scopes when configuring the GoogleSignin instance.
21+
If you want to manage other data from your application (for example, access user agenda or upload a file to drive) you need to request additional permissions. This can be accomplished by calling [`requestAuthorization`](one-tap#requestauthorization) or by
22+
adding the necessary scopes when calling [`configure`](one-tap#configure).
2223

2324
Visit https://developers.google.com/identity/protocols/googlescopes or https://developers.google.com/oauthplayground/ for a list of available scopes.

0 commit comments

Comments
 (0)