Typo fix README.md #1760
Typo fix README.md #1760
Conversation
Signed-off-by: MaxweLL22-22 <[email protected]>
MaxweLL22-22
requested review from
zmanian,
poldsam,
51N84D,
philipjames44,
henrio123,
josephterrigno and
otsalex
as code owners
|
@MaxweLL22-22 is attempting to deploy a commit to the Sommelier Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe pull request involves a minor correction in the README.md file, specifically fixing a typographical error in a sentence about IP detection. The change corrects the word "beging" to "begging" in a description of how IP detection is used in the Layout component. This is a simple documentation update with no impact on the actual code functionality. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
68-68: Format abbreviation properlyThe abbreviation "eg." should be written as "e.g." with two periods.
-(eg. `IP_COUNTRY='CA'` +(e.g., `IP_COUNTRY='CA'`🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...IP_COUNTRY, andIP_COUTNRY_REGION(eg.IP_COUNTRY='CA'`IP_COUNTRY_REGION='B...(E_G)
[style] ~68-~68: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ..., region, and a boolean that determines if they are in a restricted region or not....(IF_WHETHER)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~68-~68: The abbreviation “e.g.” (= for example) requires two periods.
Context: ... IP_COUNTRY, and IP_COUTNRY_REGION (eg. IP_COUNTRY='CA' `IP_COUNTRY_REGION='B...
(E_G)
[style] ~68-~68: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ..., region, and a boolean that determines if they are in a restricted region or not....
(IF_WHETHER)
| @@ -65,7 +65,7 @@ const hash = cellarSigner?.write.deposit( | |||
|
|
|||
| In order to block access to the app from sanctioned and restricted countries we are using Vercel's `x-vercel-ip-country` and `x-vercel-ip-country-region` to detect IP addresses. This is setup via a Next.js API route which reads the file from disk and performs a lookup against the IP. See `src/pages/api/geo.ts`. | |||
|
|
|||
| The endpoint is hardcoded to use a restricted region unless you set the env vars `IP_COUNTRY`, and `IP_COUTNRY_REGION` (eg. `IP_COUNTRY='CA'` `IP_COUNTRY_REGION='BC'`). This API endpoint is then used by our GeoProvider (see `src/context/geoContext.tsx`). You can import the `useGeo()` hook to get access to the user's country, region, and a boolean that determines if they are in a restricted region or not. It's currently beging used in the `<Layout />` component to display a "Service Unavailable" banner and to block a user from connecting their wallet to the app. | |||
| The endpoint is hardcoded to use a restricted region unless you set the env vars `IP_COUNTRY`, and `IP_COUTNRY_REGION` (eg. `IP_COUNTRY='CA'` `IP_COUNTRY_REGION='BC'`). This API endpoint is then used by our GeoProvider (see `src/context/geoContext.tsx`). You can import the `useGeo()` hook to get access to the user's country, region, and a boolean that determines if they are in a restricted region or not. It's currently begging used in the `<Layout />` component to display a "Service Unavailable" banner and to block a user from connecting their wallet to the app. | |||
There was a problem hiding this comment.
The word "begging" should be "being"
While fixing the typo "beging", the correction "begging" is also incorrect. The proper word in this context should be "being".
-It's currently begging used in the `<Layout />` component
+It's currently being used in the `<Layout />` component📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The endpoint is hardcoded to use a restricted region unless you set the env vars `IP_COUNTRY`, and `IP_COUTNRY_REGION` (eg. `IP_COUNTRY='CA'` `IP_COUNTRY_REGION='BC'`). This API endpoint is then used by our GeoProvider (see `src/context/geoContext.tsx`). You can import the `useGeo()` hook to get access to the user's country, region, and a boolean that determines if they are in a restricted region or not. It's currently begging used in the `<Layout />` component to display a "Service Unavailable" banner and to block a user from connecting their wallet to the app. | |
| The endpoint is hardcoded to use a restricted region unless you set the env vars `IP_COUNTRY`, and `IP_COUTNRY_REGION` (eg. `IP_COUNTRY='CA'` `IP_COUNTRY_REGION='BC'`). This API endpoint is then used by our GeoProvider (see `src/context/geoContext.tsx`). You can import the `useGeo()` hook to get access to the user's country, region, and a boolean that determines if they are in a restricted region or not. It's currently being used in the `<Layout />` component to display a "Service Unavailable" banner and to block a user from connecting their wallet to the app. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: The abbreviation “e.g.” (= for example) requires two periods.
Context: ... IP_COUNTRY, and IP_COUTNRY_REGION (eg. IP_COUNTRY='CA' `IP_COUNTRY_REGION='B...
(E_G)
[style] ~68-~68: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ..., region, and a boolean that determines if they are in a restricted region or not....
(IF_WHETHER)
Fix environment variable name typo
There's a typo in the environment variable name: IP_COUTNRY_REGION should be IP_COUNTRY_REGION.
-IP_COUTNRY_REGION
+IP_COUNTRY_REGION📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The endpoint is hardcoded to use a restricted region unless you set the env vars `IP_COUNTRY`, and `IP_COUTNRY_REGION` (eg. `IP_COUNTRY='CA'` `IP_COUNTRY_REGION='BC'`). This API endpoint is then used by our GeoProvider (see `src/context/geoContext.tsx`). You can import the `useGeo()` hook to get access to the user's country, region, and a boolean that determines if they are in a restricted region or not. It's currently begging used in the `<Layout />` component to display a "Service Unavailable" banner and to block a user from connecting their wallet to the app. | |
| The endpoint is hardcoded to use a restricted region unless you set the env vars `IP_COUNTRY`, and `IP_COUNTRY_REGION` (eg. `IP_COUNTRY='CA'` `IP_COUNTRY_REGION='BC'`). This API endpoint is then used by our GeoProvider (see `src/context/geoContext.tsx`). You can import the `useGeo()` hook to get access to the user's country, region, and a boolean that determines if they are in a restricted region or not. It's currently begging used in the `<Layout />` component to display a "Service Unavailable" banner and to block a user from connecting their wallet to the app. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: The abbreviation “e.g.” (= for example) requires two periods.
Context: ... IP_COUNTRY, and IP_COUTNRY_REGION (eg. IP_COUNTRY='CA' `IP_COUNTRY_REGION='B...
(E_G)
[style] ~68-~68: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ..., region, and a boolean that determines if they are in a restricted region or not....
(IF_WHETHER)
Pull Request: Fix Typo in
README.mdDescription
This pull request fixes a typo in the
README.mdfile. The word "beging" has been corrected to "begging."Changes Made
Summary by CodeRabbit