Starting code documentation

This commit is contained in:
Leonardo Bautista-Gomez 2023-02-08 22:45:01 +01:00
parent 5c55fd7854
commit cf780b3ca3
3 changed files with 10 additions and 7 deletions

View File

@ -5,7 +5,7 @@ from bitarray import bitarray
from bitarray.util import zeros
class Block:
"""This class represents a block in the Ethereum blockchain"""
def __init__(self, blockSize):
self.blockSize = blockSize

View File

@ -2,7 +2,8 @@
import logging
class CustomFormatter(logging.Formatter):
class CustomFormatter():
"""This class defines the terminal output formatting."""
blue = "\x1b[34;20m"
grey = "\x1b[38;20m"

View File

@ -6,6 +6,13 @@
Welcome to DAS simulator's documentation!
=========================================
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. toctree::
:maxdepth: 2
:caption: Contents:
@ -34,9 +41,4 @@ Welcome to DAS simulator's documentation!
.. automodule:: validator
:members:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`