feat(EOFTests): Add doc for the generated format

ethereum · Feb 3, 2023 · 206c783 · 206c783
1 parent 91c75ff
commit 206c783
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/docs/eof-ref.rst b/docs/eof-ref.rst
@@ -5,5 +5,4 @@ Ethereum Object Format Tests
    :maxdepth: 2
 
    test_filler/eof_filler.rst
-   test_types/gstate_tests.rst
-
+   test_types/eof_tests.rst
diff --git a/docs/test_types/eof_tests.rst b/docs/test_types/eof_tests.rst
@@ -0,0 +1,17 @@
+.. _eof_tests:
+
+
+==================================
+Generated Ethereum Object Format
+==================================
+
+
+
+Location `/EOFTests <https://github.com/ethereum/tests/tree/develop/EOFTests>`_
+
+
+Test Structure
+==============
+Contains **vectors**, indexed by **<test name>_<number within the file>**.
+Inside each vector that is the code being deployed, and the result for each
+fork in the test (**true** or **false**)