From aba9f0d53daced1e6434ef64095c9410823ffeec Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Sat, 14 Dec 2024 01:49:34 +0200 Subject: [PATCH] Fix Typographical Errors and Improve Documentation Clarity (#1347) * typos README.md * typos function-modifiers.md * typos filtering-an-array-sbs.md * typos contract-verification-sbs.md * typos hardhat-deploy-sbs.md * typos hardhat-testing-sbs.md * typos mappings-sbs.md * typos simple-storage-sbs.md * typos basenames-faq.md --- README.md | 2 +- .../base-learn/docs/advanced-functions/function-modifiers.md | 2 +- .../base-learn/docs/arrays/filtering-an-array-sbs.md | 2 +- .../docs/deployment-to-testnet/contract-verification-sbs.md | 2 +- .../base-learn/docs/hardhat-deploy/hardhat-deploy-sbs.md | 2 +- .../base-learn/docs/hardhat-testing/hardhat-testing-sbs.md | 4 ++-- apps/base-docs/base-learn/docs/mappings/mappings-sbs.md | 2 +- apps/base-docs/base-learn/docs/storage/simple-storage-sbs.md | 2 +- apps/base-docs/docs/tools/basenames-faq.md | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1b6a160f0c..c61cfdd9c7 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ If you're a builder who wants to add or update your project on the [Base Ecosyst 5. Create a pull request with your changes. -By opening a PR to add your project, you authorize and license Coinbase on a non-exclusive, worldwide, irrevocable, sublicensable, and royalty free basis to reproduce, distribute, transmit, make available, perform, display, or otherwise use the submitted Multimedia Assets for any purpose, including any marketing or promotional activities related to Base or Coinbase. Any goodwill associated with use of trademarks submitted in your Multimedia Assets will inure to your benefit. You further acknowledge and represent that you have all IP rights in the Multimedia Assets, that the Multimedia Assets do not infringe the rights of any third party, and that you have the right to grant this license to Coinbase. +By opening a PR to add your project, you authorize and license Coinbase on a non-exclusive, worldwide, irrevocable, sublicensable, and royalty-free basis to reproduce, distribute, transmit, make available, perform, display, or otherwise use the submitted Multimedia Assets for any purpose, including any marketing or promotional activities related to Base or Coinbase. Any goodwill associated with use of trademarks submitted in your Multimedia Assets will inure to your benefit. You further acknowledge and represent that you have all IP rights in the Multimedia Assets, that the Multimedia Assets do not infringe the rights of any third party, and that you have the right to grant this license to Coinbase. **Note:** Submissions do not guarantee inclusion and all submissions are subject to review. Your project must be live on Base to potentially be included. Ensure all information is accurate and up-to-date. diff --git a/apps/base-docs/base-learn/docs/advanced-functions/function-modifiers.md b/apps/base-docs/base-learn/docs/advanced-functions/function-modifiers.md index 8eb0565025..38e1f60bbd 100644 --- a/apps/base-docs/base-learn/docs/advanced-functions/function-modifiers.md +++ b/apps/base-docs/base-learn/docs/advanced-functions/function-modifiers.md @@ -20,7 +20,7 @@ By the end of this lesson you should be able to: By default, `public` functions can be called by **anyone**, without restriction. Often this is desirable. You want any user to be able to see what NFTs are for sale on your platform, sign up for a service, or read various items stored in state. -However, there will be many functions you **don't** want any user to be able to do, such as setting the fee for using the app, or withdrawing all of the funds in the contract! A common pattern to protect these functions is to use `modifier`s to make sure that only the owner can call these functions. +However, there will be many functions you **don't** want any user to be able to do, such as setting the fee for using the app, or withdrawing all funds in the contract! A common pattern to protect these functions is to use `modifier`s to make sure that only the owner can call these functions. :::caution diff --git a/apps/base-docs/base-learn/docs/arrays/filtering-an-array-sbs.md b/apps/base-docs/base-learn/docs/arrays/filtering-an-array-sbs.md index 7b5a53639a..7151aba48c 100644 --- a/apps/base-docs/base-learn/docs/arrays/filtering-an-array-sbs.md +++ b/apps/base-docs/base-learn/docs/arrays/filtering-an-array-sbs.md @@ -47,7 +47,7 @@ The simple and obvious solution is to simply iterate through `numbers` and count Go ahead and write it on your own. It needs to: - Instantiate a `uint` to hold the results -- Iterate through all of the values in `numbers` and increment that number if the value is even +- Iterate through all values in `numbers` and increment that number if the value is even - Return the result You should end up with something like: diff --git a/apps/base-docs/base-learn/docs/deployment-to-testnet/contract-verification-sbs.md b/apps/base-docs/base-learn/docs/deployment-to-testnet/contract-verification-sbs.md index c3a4c50bbc..60e03e65d4 100644 --- a/apps/base-docs/base-learn/docs/deployment-to-testnet/contract-verification-sbs.md +++ b/apps/base-docs/base-learn/docs/deployment-to-testnet/contract-verification-sbs.md @@ -46,7 +46,7 @@ Click the linked address to your contract to return to the contract page. You'll :::tip -If you have imports, you'll need to right click on the name of the file and choose `Flatten`. Submit the newly generated `filename_flattened.sol` for verification. +If you have imports, you'll need to right-click on the name of the file and choose `Flatten`. Submit the newly generated `filename_flattened.sol` for verification. ::: diff --git a/apps/base-docs/base-learn/docs/hardhat-deploy/hardhat-deploy-sbs.md b/apps/base-docs/base-learn/docs/hardhat-deploy/hardhat-deploy-sbs.md index 063e6a8eec..c37b2f0611 100644 --- a/apps/base-docs/base-learn/docs/hardhat-deploy/hardhat-deploy-sbs.md +++ b/apps/base-docs/base-learn/docs/hardhat-deploy/hardhat-deploy-sbs.md @@ -161,7 +161,7 @@ Reuse `Lock__factory` but use the connect function and pass the address of the n ✔ should have the right owner ✔ shouldn't allow to withdraw before unlock time (51ms) ✔ shouldn't allow to withdraw a non owner - ✔ should allow to withdraw a owner + ✔ should allow to withdraw an owner 6 passing (2s) ``` diff --git a/apps/base-docs/base-learn/docs/hardhat-testing/hardhat-testing-sbs.md b/apps/base-docs/base-learn/docs/hardhat-testing/hardhat-testing-sbs.md index 00f0b9f8ca..5e61bc4233 100644 --- a/apps/base-docs/base-learn/docs/hardhat-testing/hardhat-testing-sbs.md +++ b/apps/base-docs/base-learn/docs/hardhat-testing/hardhat-testing-sbs.md @@ -287,7 +287,7 @@ Finally, test that the owner can withdraw. You can manipulate the time similarly Reveal code ```tsx -it('should allow to withdraw a owner', async () => { +it('should allow to withdraw an owner', async () => { const balanceBefore = await ethers.provider.getBalance(await lockInstance.getAddress()); // Its value will be the one we lock at deployment time. @@ -320,7 +320,7 @@ You can then run `npx hardhat test` and you should get: ✔ should have the right owner ✔ shouldn"t allow to withdraw before unlock time (51ms) ✔ shouldn"t allow to withdraw a non owner - ✔ should allow to withdraw a owner + ✔ should allow to withdraw an owner 6 passing (2s) ``` diff --git a/apps/base-docs/base-learn/docs/mappings/mappings-sbs.md b/apps/base-docs/base-learn/docs/mappings/mappings-sbs.md index 4e1ad136a3..72472c83ef 100644 --- a/apps/base-docs/base-learn/docs/mappings/mappings-sbs.md +++ b/apps/base-docs/base-learn/docs/mappings/mappings-sbs.md @@ -118,7 +118,7 @@ Deploy and test again. Success! One challenging limitation of the `mapping` data type is that it is **not** iterable - you cannot loop through and manipulate or return **all** values in the `mapping`. -At least not with any built in features, but you can solve this on your own. A common practice in Solidity with this and similar problems is to use multiple variables or data types to store the right combination needed to address the issue. +At least not with any built-in features, but you can solve this on your own. A common practice in Solidity with this and similar problems is to use multiple variables or data types to store the right combination needed to address the issue. ### Using a Helper Array diff --git a/apps/base-docs/base-learn/docs/storage/simple-storage-sbs.md b/apps/base-docs/base-learn/docs/storage/simple-storage-sbs.md index 8ea9451e62..b99a0c2542 100644 --- a/apps/base-docs/base-learn/docs/storage/simple-storage-sbs.md +++ b/apps/base-docs/base-learn/docs/storage/simple-storage-sbs.md @@ -4,7 +4,7 @@ description: Learn how to Store data on the blockchain. hide_table_of_contents: false --- -Ultimately, the power of the blockchain is that anyone can store their data on it via the `storage` in a smart contract. In this step by step guide, you'll learn how to access and use the `storage` data location. +Ultimately, the power of the blockchain is that anyone can store their data on it via the `storage` in a smart contract. In this step-by-step guide, you'll learn how to access and use the `storage` data location. --- diff --git a/apps/base-docs/docs/tools/basenames-faq.md b/apps/base-docs/docs/tools/basenames-faq.md index a15c24d1bc..616dabf73c 100644 --- a/apps/base-docs/docs/tools/basenames-faq.md +++ b/apps/base-docs/docs/tools/basenames-faq.md @@ -76,7 +76,7 @@ Transferring all 3 to the same address will fully transfer ownership of the Base ### 11. What happens if I forget to renew my Basename? -If you forget to renew your Name, it will enter a grace period of 90 days, during which you can still renew it. If not renewed during this period, the Basename will become available for others to register. +If you forget to renew your Name, it will enter a grace period of 90-days, during which you can still renew it. If not renewed during this period, the Basename will become available for others to register. ### 12. What happens if a Basename is not renewed during the grace period?