Skip to content
New issue

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

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

Already on GitHub? # to your account

Docs should include instantiation of MiningChain #2008

Open
stnbu opened this issue May 6, 2021 · 0 comments
Open

Docs should include instantiation of MiningChain #2008

stnbu opened this issue May 6, 2021 · 0 comments

Comments

@stnbu
Copy link

stnbu commented May 6, 2021

  • py-evm Version: 0.4.0-alpha.4

What is wrong?

The documentation mentions MiningChain at the bottom of docs/cookbook/index.rst, however docs/guides/understanding_the_mining_process.rst does not show an example of MiningChain instantiation. A chain_class is assumed to exist from the start of the mining guide.

How can it be fixed

Making the code in docs/guides/understanding_the_mining_process.rst self-contained (so, including a MiningChain instantiation) would help a lot. As a total noob, I have had a lot of trouble getting the mining example to work.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant