Merge pull request #780 from jiangmencity/master

chore: fix some comments
onflow · Jan 28, 2025 · fe17c93 · fe17c93
2 parents 085706c + 8aa3418
commit fe17c93
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ There is also a block explorer GUI for the emulator, that will help you speed up
 
 ## Configuration
 
-The Flow Emulator can be run in different modes and settings, all of them are described in the table bellow.
+The Flow Emulator can be run in different modes and settings, all of them are described in the table below.
 
 Please note that if you will run the emulator using the Flow CLI you must use flags to pass configuration values
 and if you plan to run the emulator with Docker you must use the environment variables (Env) to pass configuration
@@ -64,7 +64,7 @@ values.
 | `--storage-limit`             | `FLOW_STORAGELIMITENABLED`       | `true`         | Enable [account storage limit](https://docs.onflow.org/cadence/language/accounts/#storage-limit)                                                                                                              |
 | `--storage-per-flow`          | `FLOW_STORAGEMBPERFLOW`          |                | Specify size of the storage in MB for each FLOW in account balance. Default value from the flow-go                                                                                                            |
 | `--min-account-balance`       | `FLOW_MINIMUMACCOUNTBALANCE`     |                | Specify minimum balance the account must have. Default value from the flow-go                                                                                                                                 |
-| `--transaction-fees`          | `FLOW_TRANSACTIONFEESENABLED`    | `false`        | Enable variable transaction fees and execution effort metering <br> as decribed in [Variable Transaction Fees: Execution Effort](https://github.com/onflow/flow/pull/753) FLIP                                |
+| `--transaction-fees`          | `FLOW_TRANSACTIONFEESENABLED`    | `false`        | Enable variable transaction fees and execution effort metering <br> as described in [Variable Transaction Fees: Execution Effort](https://github.com/onflow/flow/pull/753) FLIP                                |
 | `--transaction-max-gas-limit` | `FLOW_TRANSACTIONMAXGASLIMIT`    | `9999`         | Maximum [gas limit for transactions](https://docs.onflow.org/flow-go-sdk/building-transactions/#gas-limit)                                                                                                    |
 | `--script-gas-limit`          | `FLOW_SCRIPTGASLIMIT`            | `100000`       | Specify gas limit for script execution                                                                                                                                                                        |
 | `--coverage-reporting`        | `FLOW_COVERAGEREPORTING`         | `false`        | Enable Cadence code coverage reporting                                                                                                                                                                        |

diff --git a/docs/overview.md b/docs/overview.md
@@ -34,7 +34,7 @@ There is also a block explorer GUI for the emulator, that will help you speed up
 
 ## Configuration
 
-The Flow Emulator can be run in different modes and settings, all of them are described in the table bellow.
+The Flow Emulator can be run in different modes and settings, all of them are described in the table below.
 
 Please note that if you will run the emulator using the Flow CLI you must use flags to pass configuration values
 and if you plan to run the emulator with Docker you must use the environment variables (Env) to pass configuration
@@ -64,7 +64,7 @@ values.
 | `--storage-limit`               | `FLOW_STORAGELIMITENABLED`       | `true`         | Enable [account storage limit](https://docs.onflow.org/cadence/language/accounts/#storage-limit)                                                                                                            |
 | `--storage-per-flow`            | `FLOW_STORAGEMBPERFLOW`          |                | Specify size of the storage in MB for each FLOW in account balance. Default value from the flow-go                                                                                                          |
 | `--min-account-balance`         | `FLOW_MINIMUMACCOUNTBALANCE`     |                | Specify minimum balance the account must have. Default value from the flow-go                                                                                                                               |
-| `--transaction-fees`            | `FLOW_TRANSACTIONFEESENABLED`    | `false`        | Enable variable transaction fees and execution effort metering <br> as decribed in [Variable Transaction Fees: Execution Effort](https://github.com/onflow/flow/pull/753) FLIP                              |
+| `--transaction-fees`            | `FLOW_TRANSACTIONFEESENABLED`    | `false`        | Enable variable transaction fees and execution effort metering <br> as described in [Variable Transaction Fees: Execution Effort](https://github.com/onflow/flow/pull/753) FLIP                              |
 | `--transaction-max-gas-limit`   | `FLOW_TRANSACTIONMAXGASLIMIT`    | `9999`         | Maximum [gas limit for transactions](https://docs.onflow.org/flow-go-sdk/building-transactions/#gas-limit)                                                                                                  |
 | `--script-gas-limit`            | `FLOW_SCRIPTGASLIMIT`            | `100000`       | Specify gas limit for script execution                                                                                                                                                                      |
 | `--with-contracts`              | `FLOW_WITHCONTRACTS`             | `false`        | Deploy common contracts when emulator starts                                                                                                                                                                |

diff --git a/emulator/blockchain_test.go b/emulator/blockchain_test.go
@@ -63,7 +63,7 @@ const counterScript = `
   }
 `
 
-// generateAddTwoToCounterScript generates a script that increments a counter.
+// GenerateAddTwoToCounterScript generates a script that increments a counter.
 // If no counter exists, it is created.
 func GenerateAddTwoToCounterScript(counterAddress flowsdk.Address) string {
 	return fmt.Sprintf(

diff --git a/server/server.go b/server/server.go
@@ -137,7 +137,7 @@ type Config struct {
 	SqliteURL string
 	// CoverageReportingEnabled enables/disables Cadence code coverage reporting.
 	CoverageReportingEnabled bool
-	// LegacyUpgradeEnabled enables/disables Cadence legacy contracts upgrades
+	// LegacyContractUpgradeEnabled enables/disables Cadence legacy contracts upgrades
 	LegacyContractUpgradeEnabled bool
 	// RPCHost is the address of the access node to use when using a forked network.
 	RPCHost string

diff --git a/server/utils/liveness/check.go b/server/utils/liveness/check.go
@@ -46,7 +46,7 @@ func (c *internalCheck) CheckIn() {
 	c.lock.Unlock()
 }
 
-// IsLive checks if we are still live against the given the tolerance between hearbeats.
+// IsLive checks if we are still live against the given the tolerance between heartbeats.
 //
 // If tolerance is 0, the default tolerance is used.
 func (c *internalCheck) IsLive(tolerance time.Duration) bool {

diff --git a/server/utils/liveness/collector.go b/server/utils/liveness/collector.go
@@ -95,7 +95,7 @@ func (c *CheckCollector) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	w.WriteHeader(http.StatusOK)
 }
 
-// IsLive checks if we are still live against the given the tolerance between hearbeats.
+// IsLive checks if we are still live against the given the tolerance between heartbeats.
 //
 // If tolerance is 0, the default tolerance is used.
 func (c *CheckCollector) IsLive(tolerance time.Duration) bool {

diff --git a/storage/checkpoint/checkpoint.go b/storage/checkpoint/checkpoint.go
@@ -39,7 +39,7 @@ import (
 	"github.com/onflow/flow-emulator/storage/memstore"
 )
 
-// Store is jus a memstore, but the starting state is loaded from a checkpoint folder
+// Store is just a memstore, but the starting state is loaded from a checkpoint folder
 // any new blocks exist in memory only and are not persisted to disk.
 type Store struct {
 	// Store is a memstore