fix: typos and grammer errors (#147)

Cyfrin · Nov 14, 2024 · 0a6aad4 · 0a6aad4
1 parent cc982d3
commit 0a6aad4
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/docs/source/all_moccasin_toml_parameters.rst b/docs/source/all_moccasin_toml_parameters.rst
@@ -1,10 +1,10 @@
-All moccasin toml parameters
+All moccasin TOML Parameters
 ============================
 
 TOML Formatting
 ---------------
 
-In TOML you can think of each section as a giant JSON object. Each of these are essentially identical:
+In TOML, you can think of each section as a giant JSON object. Each of these are essentially identical:
 
 +----------------------------------+----------------------------------+----------------------------------+
 | TOML (Expanded)                  | TOML (Compact)                   | JSON                             |
@@ -103,7 +103,7 @@ All possible options
 Environment Variables 
 ---------------------
 
-Additionally, there are a few environment variables that ``moccasin`` will look for, but it's also ok if they are not set. It's important to note, that the `.env` file you set in the config will be ignored for these values. 
+Additionally, there are a few environment variables that ``moccasin`` will look for, but it's also okay if they are not set. It's important to note, that the `.env` file you set in the config will be ignored for these values. 
 
 .. code-block:: bash 
 

diff --git a/docs/source/common_errors.rst b/docs/source/common_errors.rst
@@ -4,4 +4,4 @@ Common Errors
 ValueError: <boa.network.NetworkEnv object at 0xXXXXXXXXX>.eoa not defined!
 ----------------------------------------------------------------------------
 
-This is the most common error you'll run into, and it means you'll need to add an account to your ``moccasin.toml``. You can do this by following the :doc:`wallet <core_concepts/wallet>` guide.
+This is the most common error you'll encounter, and it means you'll need to add an account to your ``moccasin.toml`` file. You can do this by following the :doc:`wallet <core_concepts/wallet>` guide.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -35,7 +35,7 @@ Moccasin is a fast, pythonic smart contract development framework heavily powere
         explorer            Work with block explorers to get data.
         inspect             Inspect compiler data of a contract.
         deployments         View deployments of the project from your DB.
-        utils (u, util)     Helpful utilities - right now it's just the one.
+        utils (u, util)     Helpful utilities - currently only one is available.
 
     options:
     -h, --help            show this help message and exit
@@ -45,13 +45,13 @@ Moccasin is a fast, pythonic smart contract development framework heavily powere
 How to read the documentation
 =============================
 
-The moccasin documentation is written in a way that assumes you are on a MacOS or Linux-like system. If you are using windows, we recommend you watch the first `10 minutes of this WSL tutorial <https://www.youtube.com/watch?v=xqUZ4JqHI_8>`_ and work with WSL. WSL stands for "Windows Subsystem for Linux" and it allows you to run a Linux commands on Windows machine.
+The moccasin documentation is written in a way that assumes you are on a MacOS or Linux-like system. If you are using Windows, we recommend you watch the first `10 minutes of this WSL tutorial <https://www.youtube.com/watch?v=xqUZ4JqHI_8>`_ and work with WSL. WSL stands for "Windows Subsystem for Linux" and it allows you to run a Linux commands on Windows machine.
 
 
 TOML Formatting
 ---------------
 
-In TOML you can think of each section as a giant JSON object. Each of these are essentially identical:
+In TOML, you can think of each section as a giant JSON object. Each of these are essentially identical:
 
 +----------------------------------+----------------------------------+----------------------------------+
 | TOML (Expanded)                  | TOML (Compact)                   | JSON                             |
@@ -81,7 +81,7 @@ Why Moccasin?
 We think web3 needs the following:
 
 1. A python smart contract development framework.
-    a. We need this because python is the 2nd most popular language on earth, and is the number one choice for artificial intelligence and new computer engineers!
+    a. We need this because python is the 2nd most popular language on earth and is the number one choice for artificial intelligence and new computer engineers!
 2. An easy way to run devops on contracts.
     a. Running scripts to interact with contracts needs to be easy in a language that humans can understand.
 3. And finally... it needs to be fast!

diff --git a/docs/source/tutorials/zksync-getting-started.rst b/docs/source/tutorials/zksync-getting-started.rst
@@ -17,7 +17,7 @@ To get started with ZKsync on ``moccasin``, you'll need the following:
 Testing 
 =======
 
-To test on a local zksync network, run the following:
+To test on a local ZKsync network, run the following:
 
 .. code-block:: bash
 
@@ -32,7 +32,7 @@ And you'll spin up a local ZKsync network and run your tests on it! You can then
 Deployment 
 ==========
 
-To deploy to a zksync network, you have to do a lot of work.
+To deploy to a ZKsync network, you have to do a lot of work.
 
 1. Setup your network
 =====================