Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Begin the long process of converting reStructuredText to markdown #862

Merged
merged 3 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[*.py]
max_line_length = 79
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ transform = [
"docc.python.transform",
"docc.verbatim.transform",
"docc.mistletoe.transform",
"docc.mistletoe.reference",
"ethereum_spec_tools.docc.fix-indexes",
"ethereum_spec_tools.docc.minimize-diffs",
"docc.references.index",
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ lint =
flake8-spellcheck==0.28.0

doc =
docc>=0.1.0,<0.2.0
docc>=0.2.0,<0.3.0
fladrif>=0.2.0,<0.3.0

optimized =
Expand Down
4 changes: 2 additions & 2 deletions src/ethereum/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Ethereum Specification
^^^^^^^^^^^^^^^^^^^^^^
### Introduction

Seeing as internet connections have been vastly expanding across the
world, spreading information has become as cheap as ever. Bitcoin, for
example, has demonstrated the possibility of creating a decentralized,
Expand Down
6 changes: 2 additions & 4 deletions src/ethereum/arrow_glacier/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
"""
Ethereum Arrow Glacier Hardfork
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The Twelfth Ethereum hardfork.
The Arrow Glacier fork delays the difficulty bomb. There are no other changes
in this fork.
"""

from ethereum.fork_criteria import ByBlockNumber
Expand Down
12 changes: 1 addition & 11 deletions src/ethereum/arrow_glacier/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
"""
Hardfork Utility Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. contents:: Table of Contents
:backlinks: none
:local:

Introduction
------------

Utility functions used in this arrow_glacier version of specification.
Utility functions unique to this particular fork.
"""
7 changes: 3 additions & 4 deletions src/ethereum/berlin/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
"""
Ethereum Berlin Hardfork
^^^^^^^^^^^^^^^^^^^^^^^^

The Tenth Ethereum hardfork.
The Berlin fork adjusts the gas costs of the `ModExp` precompile and several
state access EVM instructions, introduces typed transaction envelopes along
with the first new transaction type—optional access lists.
"""

from ethereum.fork_criteria import ByBlockNumber
Expand Down
12 changes: 1 addition & 11 deletions src/ethereum/berlin/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
"""
Hardfork Utility Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. contents:: Table of Contents
:backlinks: none
:local:

Introduction
------------

Utility functions used in this berlin version of specification.
Utility functions unique to this particular fork.
"""
7 changes: 3 additions & 4 deletions src/ethereum/byzantium/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
"""
Ethereum Byzantium Hardfork
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The sixth Ethereum hardfork.
The Byzantium fork reduces the mining rewards, delays the difficulty bomb,
lets contracts make non-state-changing calls to other contracts, and adds
cryptographic primitives for layer 2 scaling.
"""

from ethereum.fork_criteria import ByBlockNumber
Expand Down
12 changes: 1 addition & 11 deletions src/ethereum/byzantium/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
"""
Hardfork Utility Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. contents:: Table of Contents
:backlinks: none
:local:

Introduction
------------

Utility functions used in this byzantium version of specification.
Utility functions unique to this particular fork.
"""
7 changes: 3 additions & 4 deletions src/ethereum/constantinople/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
"""
Ethereum Constantinople Hardfork
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The Seventh Ethereum hardfork.
The Constantinople fork reduces mining rewards, delays the difficulty bomb,
and introduces new EVM instructions for logical shifts, counterfactual
contract deployment, and computing bytecode hashes.
"""

from ethereum.fork_criteria import ByBlockNumber
Expand Down
12 changes: 1 addition & 11 deletions src/ethereum/constantinople/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
"""
Hardfork Utility Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. contents:: Table of Contents
:backlinks: none
:local:

Introduction
------------

Utility functions used in this constantinople version of specification.
Utility functions unique to this particular fork.
"""
12 changes: 1 addition & 11 deletions src/ethereum/crypto/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
"""
Cryptographic Functions
^^^^^^^^^^^^^^^^^^^^^^^

.. contents:: Table of Contents
:backlinks: none
:local:

Introduction
------------

Cryptographic primatives used in Ethereum.
Cryptographic primitives used in Ethereum.
"""
7 changes: 3 additions & 4 deletions src/ethereum/dao_fork/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
"""
Ethereum Dao Hardfork
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The third Ethereum hardfork.
The DAO Fork is a response to a smart contract exploit known as the 2016 DAO
Attack where a vulnerable contract was drained of its ether. This fork recovers
the stolen funds into a new contract.
"""

from ethereum.fork_criteria import ByBlockNumber
Expand Down
12 changes: 1 addition & 11 deletions src/ethereum/dao_fork/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
"""
Hardfork Utility Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. contents:: Table of Contents
:backlinks: none
:local:

Introduction
------------

Utility functions used in this Dao Fork version of specification.
Utility functions unique to this particular fork.
"""
Loading
Loading