docs: fix grammar in src/ethereum/forks/*/vm/instructions (keccak, log, memory, stack)

repo_subpaths_for_grammar_check.md

@@ -8,7 +8,7 @@ Status legend: `[ ]` pending, `[~]` in progress, `[x]` complete
 
 - [x] `src/ethereum/forks/*/vm/instructions/arithmetic.py`, `comparison.py`, `bitwise.py` (~72 files)
 - [x] `src/ethereum/forks/*/vm/instructions/block.py`, `environment.py`, `control_flow.py` (~72 files)
-- [ ] `src/ethereum/forks/*/vm/instructions/keccak.py`, `log.py`, `memory.py`, `stack.py` (~96 files)
+- [x] `src/ethereum/forks/*/vm/instructions/keccak.py`, `log.py`, `memory.py`, `stack.py` (~96 files)
 - [ ] `src/ethereum/forks/*/vm/instructions/storage.py`, `system.py`, `__init__.py` (~72 files)
 
 ## src/ethereum/forks - VM Core

src/ethereum/forks/amsterdam/vm/instructions/memory.py

@@ -93,7 +93,7 @@ def mstore8(evm: Evm) -> None:
 
 def mload(evm: Evm) -> None:
     """
-    Load word from memory.
+    Loads a word from memory.
 
     Parameters
     ----------
@@ -123,7 +123,7 @@ def mload(evm: Evm) -> None:
 
 def msize(evm: Evm) -> None:
     """
-    Push the size of active memory in bytes onto the stack.
+    Pushes the size of active memory in bytes onto the stack.
 
     Parameters
     ----------
@@ -146,7 +146,7 @@ def msize(evm: Evm) -> None:
 
 def mcopy(evm: Evm) -> None:
     """
-    Copy the bytes in memory from one location to another.
+    Copies the bytes in memory from one location to another.
 
     Parameters
     ----------

src/ethereum/forks/amsterdam/vm/instructions/stack.py

@@ -23,7 +23,7 @@
 
 def pop(evm: Evm) -> None:
     """
-    Remove item from stack.
+    Removes an item from the stack.
 
     Parameters
     ----------
@@ -46,7 +46,7 @@ def pop(evm: Evm) -> None:
 
 def push_n(evm: Evm, num_bytes: int) -> None:
     """
-    Pushes a N-byte immediate onto the stack. Push zero if num_bytes is zero.
+    Pushes an N-byte immediate onto the stack. Push zero if num_bytes is zero.
 
     Parameters
     ----------
@@ -79,7 +79,7 @@ def push_n(evm: Evm, num_bytes: int) -> None:
 
 def dup_n(evm: Evm, item_number: int) -> None:
     """
-    Duplicate the Nth stack item (from top of the stack) to the top of stack.
+    Duplicates the Nth stack item (from top of the stack) to the top of stack.
 
     Parameters
     ----------
@@ -107,7 +107,7 @@ def dup_n(evm: Evm, item_number: int) -> None:
 
 def swap_n(evm: Evm, item_number: int) -> None:
     """
-    Swap the top and the `item_number` element of the stack, where
+    Swaps the top and the `item_number` element of the stack, where
     the top of the stack is position zero.
 
     If `item_number` is zero, this function does nothing (which should not be

src/ethereum/forks/arrow_glacier/vm/instructions/memory.py

@@ -90,7 +90,7 @@ def mstore8(evm: Evm) -> None:
 
 def mload(evm: Evm) -> None:
     """
-    Load word from memory.
+    Loads a word from memory.
 
     Parameters
     ----------
@@ -120,7 +120,7 @@ def mload(evm: Evm) -> None:
 
 def msize(evm: Evm) -> None:
     """
-    Push the size of active memory in bytes onto the stack.
+    Pushes the size of active memory in bytes onto the stack.
 
     Parameters
     ----------

src/ethereum/forks/arrow_glacier/vm/instructions/stack.py

@@ -23,7 +23,7 @@
 
 def pop(evm: Evm) -> None:
     """
-    Remove item from stack.
+    Removes an item from the stack.
 
     Parameters
     ----------
@@ -46,7 +46,7 @@ def pop(evm: Evm) -> None:
 
 def push_n(evm: Evm, num_bytes: int) -> None:
     """
-    Pushes a N-byte immediate onto the stack.
+    Pushes an N-byte immediate onto the stack.
 
     Parameters
     ----------
@@ -76,7 +76,7 @@ def push_n(evm: Evm, num_bytes: int) -> None:
 
 def dup_n(evm: Evm, item_number: int) -> None:
     """
-    Duplicate the Nth stack item (from top of the stack) to the top of stack.
+    Duplicates the Nth stack item (from top of the stack) to the top of stack.
 
     Parameters
     ----------
@@ -104,7 +104,7 @@ def dup_n(evm: Evm, item_number: int) -> None:
 
 def swap_n(evm: Evm, item_number: int) -> None:
     """
-    Swap the top and the `item_number` element of the stack, where
+    Swaps the top and the `item_number` element of the stack, where
     the top of the stack is position zero.
 
     If `item_number` is zero, this function does nothing (which should not be

src/ethereum/forks/berlin/vm/instructions/memory.py

@@ -90,7 +90,7 @@ def mstore8(evm: Evm) -> None:
 
 def mload(evm: Evm) -> None:
     """
-    Load word from memory.
+    Loads a word from memory.
 
     Parameters
     ----------
@@ -120,7 +120,7 @@ def mload(evm: Evm) -> None:
 
 def msize(evm: Evm) -> None:
     """
-    Push the size of active memory in bytes onto the stack.
+    Pushes the size of active memory in bytes onto the stack.
 
     Parameters
     ----------

src/ethereum/forks/berlin/vm/instructions/stack.py

@@ -23,7 +23,7 @@
 
 def pop(evm: Evm) -> None:
     """
-    Remove item from stack.
+    Removes an item from the stack.
 
     Parameters
     ----------
@@ -46,7 +46,7 @@ def pop(evm: Evm) -> None:
 
 def push_n(evm: Evm, num_bytes: int) -> None:
     """
-    Pushes a N-byte immediate onto the stack.
+    Pushes an N-byte immediate onto the stack.
 
     Parameters
     ----------
@@ -76,7 +76,7 @@ def push_n(evm: Evm, num_bytes: int) -> None:
 
 def dup_n(evm: Evm, item_number: int) -> None:
     """
-    Duplicate the Nth stack item (from top of the stack) to the top of stack.
+    Duplicates the Nth stack item (from top of the stack) to the top of stack.
 
     Parameters
     ----------
@@ -104,7 +104,7 @@ def dup_n(evm: Evm, item_number: int) -> None:
 
 def swap_n(evm: Evm, item_number: int) -> None:
     """
-    Swap the top and the `item_number` element of the stack, where
+    Swaps the top and the `item_number` element of the stack, where
     the top of the stack is position zero.
 
     If `item_number` is zero, this function does nothing (which should not be

src/ethereum/forks/bpo1/vm/instructions/memory.py

@@ -93,7 +93,7 @@ def mstore8(evm: Evm) -> None:
 
 def mload(evm: Evm) -> None:
     """
-    Load word from memory.
+    Loads a word from memory.
 
     Parameters
     ----------
@@ -123,7 +123,7 @@ def mload(evm: Evm) -> None:
 
 def msize(evm: Evm) -> None:
     """
-    Push the size of active memory in bytes onto the stack.
+    Pushes the size of active memory in bytes onto the stack.
 
     Parameters
     ----------
@@ -146,7 +146,7 @@ def msize(evm: Evm) -> None:
 
 def mcopy(evm: Evm) -> None:
     """
-    Copy the bytes in memory from one location to another.
+    Copies the bytes in memory from one location to another.
 
     Parameters
     ----------

src/ethereum/forks/bpo1/vm/instructions/stack.py

@@ -23,7 +23,7 @@
 
 def pop(evm: Evm) -> None:
     """
-    Remove item from stack.
+    Removes an item from the stack.
 
     Parameters
     ----------
@@ -46,7 +46,7 @@ def pop(evm: Evm) -> None:
 
 def push_n(evm: Evm, num_bytes: int) -> None:
     """
-    Pushes a N-byte immediate onto the stack. Push zero if num_bytes is zero.
+    Pushes an N-byte immediate onto the stack. Push zero if num_bytes is zero.
 
     Parameters
     ----------
@@ -79,7 +79,7 @@ def push_n(evm: Evm, num_bytes: int) -> None:
 
 def dup_n(evm: Evm, item_number: int) -> None:
     """
-    Duplicate the Nth stack item (from top of the stack) to the top of stack.
+    Duplicates the Nth stack item (from top of the stack) to the top of stack.
 
     Parameters
     ----------
@@ -107,7 +107,7 @@ def dup_n(evm: Evm, item_number: int) -> None:
 
 def swap_n(evm: Evm, item_number: int) -> None:
     """
-    Swap the top and the `item_number` element of the stack, where
+    Swaps the top and the `item_number` element of the stack, where
     the top of the stack is position zero.
 
     If `item_number` is zero, this function does nothing (which should not be

src/ethereum/forks/bpo2/vm/instructions/memory.py

@@ -93,7 +93,7 @@ def mstore8(evm: Evm) -> None:
 
 def mload(evm: Evm) -> None:
     """
-    Load word from memory.
+    Loads a word from memory.
 
     Parameters
     ----------
@@ -123,7 +123,7 @@ def mload(evm: Evm) -> None:
 
 def msize(evm: Evm) -> None:
     """
-    Push the size of active memory in bytes onto the stack.
+    Pushes the size of active memory in bytes onto the stack.
 
     Parameters
     ----------
@@ -146,7 +146,7 @@ def msize(evm: Evm) -> None:
 
 def mcopy(evm: Evm) -> None:
     """
-    Copy the bytes in memory from one location to another.
+    Copies the bytes in memory from one location to another.
 
     Parameters
     ----------

src/ethereum/forks/bpo2/vm/instructions/stack.py

@@ -23,7 +23,7 @@
 
 def pop(evm: Evm) -> None:
     """
-    Remove item from stack.
+    Removes an item from the stack.
 
     Parameters
     ----------
@@ -46,7 +46,7 @@ def pop(evm: Evm) -> None:
 
 def push_n(evm: Evm, num_bytes: int) -> None:
     """
-    Pushes a N-byte immediate onto the stack. Push zero if num_bytes is zero.
+    Pushes an N-byte immediate onto the stack. Push zero if num_bytes is zero.
 
     Parameters
     ----------
@@ -79,7 +79,7 @@ def push_n(evm: Evm, num_bytes: int) -> None:
 
 def dup_n(evm: Evm, item_number: int) -> None:
     """
-    Duplicate the Nth stack item (from top of the stack) to the top of stack.
+    Duplicates the Nth stack item (from top of the stack) to the top of stack.
 
     Parameters
     ----------
@@ -107,7 +107,7 @@ def dup_n(evm: Evm, item_number: int) -> None:
 
 def swap_n(evm: Evm, item_number: int) -> None:
     """
-    Swap the top and the `item_number` element of the stack, where
+    Swaps the top and the `item_number` element of the stack, where
     the top of the stack is position zero.
 
     If `item_number` is zero, this function does nothing (which should not be

src/ethereum/forks/bpo3/vm/instructions/memory.py

@@ -93,7 +93,7 @@ def mstore8(evm: Evm) -> None:
 
 def mload(evm: Evm) -> None:
     """
-    Load word from memory.
+    Loads a word from memory.
 
     Parameters
     ----------
@@ -123,7 +123,7 @@ def mload(evm: Evm) -> None:
 
 def msize(evm: Evm) -> None:
     """
-    Push the size of active memory in bytes onto the stack.
+    Pushes the size of active memory in bytes onto the stack.
 
     Parameters
     ----------
@@ -146,7 +146,7 @@ def msize(evm: Evm) -> None:
 
 def mcopy(evm: Evm) -> None:
     """
-    Copy the bytes in memory from one location to another.
+    Copies the bytes in memory from one location to another.
 
     Parameters
     ----------

src/ethereum/forks/bpo3/vm/instructions/stack.py

@@ -23,7 +23,7 @@
 
 def pop(evm: Evm) -> None:
     """
-    Remove item from stack.
+    Removes an item from the stack.
 
     Parameters
     ----------
@@ -46,7 +46,7 @@ def pop(evm: Evm) -> None:
 
 def push_n(evm: Evm, num_bytes: int) -> None:
     """
-    Pushes a N-byte immediate onto the stack. Push zero if num_bytes is zero.
+    Pushes an N-byte immediate onto the stack. Push zero if num_bytes is zero.
 
     Parameters
     ----------
@@ -79,7 +79,7 @@ def push_n(evm: Evm, num_bytes: int) -> None:
 
 def dup_n(evm: Evm, item_number: int) -> None:
     """
-    Duplicate the Nth stack item (from top of the stack) to the top of stack.
+    Duplicates the Nth stack item (from top of the stack) to the top of stack.
 
     Parameters
     ----------
@@ -107,7 +107,7 @@ def dup_n(evm: Evm, item_number: int) -> None:
 
 def swap_n(evm: Evm, item_number: int) -> None:
     """
-    Swap the top and the `item_number` element of the stack, where
+    Swaps the top and the `item_number` element of the stack, where
     the top of the stack is position zero.
 
     If `item_number` is zero, this function does nothing (which should not be

src/ethereum/forks/bpo4/vm/instructions/memory.py

@@ -93,7 +93,7 @@ def mstore8(evm: Evm) -> None:
 
 def mload(evm: Evm) -> None:
     """
-    Load word from memory.
+    Loads a word from memory.
 
     Parameters
     ----------
@@ -123,7 +123,7 @@ def mload(evm: Evm) -> None:
 
 def msize(evm: Evm) -> None:
     """
-    Push the size of active memory in bytes onto the stack.
+    Pushes the size of active memory in bytes onto the stack.
 
     Parameters
     ----------
@@ -146,7 +146,7 @@ def msize(evm: Evm) -> None:
 
 def mcopy(evm: Evm) -> None:
     """
-    Copy the bytes in memory from one location to another.
+    Copies the bytes in memory from one location to another.
 
     Parameters
     ----------