From e5fb407e102402c849ada69a45aaacc8dacd0bb6 Mon Sep 17 00:00:00 2001 From: enjoyooor <147568088+enjoyooor@users.noreply.github.com> Date: Mon, 4 Mar 2024 11:07:22 -0500 Subject: [PATCH] chore: tidy up docs (#335) --- .../base-camp/docs/advanced-functions/function-modifiers.md | 2 +- apps/base-docs/base-camp/docs/error-triage/error-triage.md | 2 +- .../base-camp/docs/minimal-tokens/minimal-token-sbs.md | 4 ++-- apps/base-docs/docs/building-with-base/differences.md | 2 +- .../docs/building-with-base/guides/using-supra-vrf.md | 2 +- apps/base-docs/docs/tokens.md | 2 +- apps/base-docs/docs/tools/viem.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/apps/base-docs/base-camp/docs/advanced-functions/function-modifiers.md b/apps/base-docs/base-camp/docs/advanced-functions/function-modifiers.md index 837a6bd..e047678 100644 --- a/apps/base-docs/base-camp/docs/advanced-functions/function-modifiers.md +++ b/apps/base-docs/base-camp/docs/advanced-functions/function-modifiers.md @@ -4,7 +4,7 @@ description: Build custom function modifiers to efficiently modify functionality hide_table_of_contents: false --- -Function modifiers allow you to efficiently change the behavior of functions. In some ways it's similar to inheritance, but there are restrictions, particularly in variable scope. +Function modifiers allow you to efficiently change the behavior of functions. In some ways, it's similar to inheritance, but there are restrictions, particularly in variable scope. --- diff --git a/apps/base-docs/base-camp/docs/error-triage/error-triage.md b/apps/base-docs/base-camp/docs/error-triage/error-triage.md index 7b3c6ef..d9a8085 100644 --- a/apps/base-docs/base-camp/docs/error-triage/error-triage.md +++ b/apps/base-docs/base-camp/docs/error-triage/error-triage.md @@ -317,7 +317,7 @@ The default settings for Remix make it difficult to trigger an out of gas error If you write code that can have an ambiguous execution time, it becomes very difficult to accurately estimate gas limits. -In this example, each loop as a 1 in 1000 chance of ending. +In this example, each loop has a 1 in 1000 chance of ending. :::warning diff --git a/apps/base-docs/base-camp/docs/minimal-tokens/minimal-token-sbs.md b/apps/base-docs/base-camp/docs/minimal-tokens/minimal-token-sbs.md index fc82eb3..ac5a792 100644 --- a/apps/base-docs/base-camp/docs/minimal-tokens/minimal-token-sbs.md +++ b/apps/base-docs/base-camp/docs/minimal-tokens/minimal-token-sbs.md @@ -91,7 +91,7 @@ Note: The called function should be payable if you send value and the value you Debug the transaction to get more information. ``` -You won't be able to do it, though the `Note:` here is **misleading**. In the EVM, `payable` **only** refers to transfers of the primary token used to pay gas fees: ETH, Base ETH, Sepolia ETH, Matic, etc. It is **not** referring to the balance of our simple token. +You won't be able to do it, though the `Note:` here is **misleading**. In the EVM, `payable` **only** refers to transfers of the primary token used to pay gas fees: ETH, Base ETH, Sepolia ETH, Matic, etc. It does **not** refer to the balance of our simple token. Instead, the transaction is reverting because of the built-in overflow/underflow protection. It's not a great programming practice to depend on this, so add an error for `InsufficientTokens` that returns the `newSenderBalance`. @@ -137,7 +137,7 @@ The `totalSupply` remains unchanged, and the balance of the zero address are vis :::info -The [zero address] currently has a balance of more than 11,000 ETH, worth over **20 million dollars**! It's total holding of burned assets are estimated to be worth more than **200 million dollars**!!! +The [zero address] currently has a balance of more than 11,000 ETH, worth over **20 million dollars**! Its total holding of burned assets is estimated to be worth more than **200 million dollars**!!! ::: diff --git a/apps/base-docs/docs/building-with-base/differences.md b/apps/base-docs/docs/building-with-base/differences.md index f04bd86..2f8581a 100644 --- a/apps/base-docs/docs/building-with-base/differences.md +++ b/apps/base-docs/docs/building-with-base/differences.md @@ -20,7 +20,7 @@ keywords: # Differences between Ethereum and Base -Base is built on the [Bedrock](https://stack.optimism.io/docs/releases/bedrock/explainer/) release of the [OP Stack](https://stack.optimism.io/), which is designed from the ground up to be as close to Ethereum as possible. Because of this, there are very little differences when it comes to building on Base and Ethereum. +Base is built on the [Bedrock](https://stack.optimism.io/docs/releases/bedrock/explainer/) release of the [OP Stack](https://stack.optimism.io/), which is designed from the ground up to be as close to Ethereum as possible. Because of this, there are very few differences when it comes to building on Base and Ethereum. However, there are still some minor discrepancies between the behavior of Base and Ethereum that you should be aware of when building apps on top of Base. diff --git a/apps/base-docs/docs/building-with-base/guides/using-supra-vrf.md b/apps/base-docs/docs/building-with-base/guides/using-supra-vrf.md index 43e5d9a..ba3f1f4 100644 --- a/apps/base-docs/docs/building-with-base/guides/using-supra-vrf.md +++ b/apps/base-docs/docs/building-with-base/guides/using-supra-vrf.md @@ -295,7 +295,7 @@ You must whitelist this smart contract under the wallet address you registered w Follow the [guidance steps](https://supraoracles.com/docs/vrf/v2-guide#step-1-create-the-supra-router-contract-interface-1) provided by Supra for whitelisting your contract and depositing funds. -If you have not yet registered your wallet with Supra, see the [Prerequisites](#prerequisites)section. +If you have not yet registered your wallet with Supra, see the [Prerequisites](#prerequisites) section. ::: --- diff --git a/apps/base-docs/docs/tokens.md b/apps/base-docs/docs/tokens.md index c162e61..ca1ec1d 100644 --- a/apps/base-docs/docs/tokens.md +++ b/apps/base-docs/docs/tokens.md @@ -23,7 +23,7 @@ This page is intended for token issuers who already have an ERC-20 contract depl **_Note - Tokens approved in the Github repository are not necessarily listed on the Base Bridge._** -**_Disclaimer: Base does not endorse any of the tokens that are listed in the Github repository and has conducted only preliminary checks, which includes automated checks listed_** [**_here_**](https://github.com/ethereum-optimism/ethereum-optimism.github.io)**_._** +**_Disclaimer: Base does not endorse any of the tokens that are listed in the Github repository and has conducted only preliminary checks, which include automated checks listed_** [**_here_**](https://github.com/ethereum-optimism/ethereum-optimism.github.io)**_._** --- diff --git a/apps/base-docs/docs/tools/viem.md b/apps/base-docs/docs/tools/viem.md index db07bfe..26b2843 100644 --- a/apps/base-docs/docs/tools/viem.md +++ b/apps/base-docs/docs/tools/viem.md @@ -105,7 +105,7 @@ To use Base Sepolia (testnet), replace `base` with `baseSepolia`. ## Interacting with smart contracts -You can use viem to interact with a smart contract on Base by creating a `Contract` instance using [`getContract`](https://viem.sh/docs/contract/getContract.html) and passing it the contract ABI, contract address, and and [Public](https://viem.sh/docs/clients/public.html) and/or [Wallet](https://viem.sh/docs/clients/wallet.html) Client: +You can use viem to interact with a smart contract on Base by creating a `Contract` instance using [`getContract`](https://viem.sh/docs/contract/getContract.html) and passing it the contract ABI, contract address, and [Public](https://viem.sh/docs/clients/public.html) and/or [Wallet](https://viem.sh/docs/clients/wallet.html) Client: ```javascript import { getContract } from 'viem';