py-evm icon indicating copy to clipboard operation
py-evm copied to clipboard

Documentation update for ABC base classes

Open pipermerriam opened this issue 6 years ago • 1 comments

What is wrong?

Previous to https://github.com/ethereum/py-evm/pull/1805 we had classes like eth.vm.BaseVM that served as the reference. Now, we have interfaces defined in eth.abc.

There are now two primary problems.

  • Many of our docstrings might still refer to the wrong class. Most class references in docstrings should be referencing the abc base classes now.
  • Most of the methods and properties on our abc base classes don't have docstrings.

How can it be fixed

Need to update existing docstrings to point to the right classes and add docstrings to all of the methods in the eth.abc directory.

Bonus points for documenting the class properties too.

pipermerriam avatar Aug 01 '19 17:08 pipermerriam

I labeled this as Good First Issue though it may require some domain knowledge to properly write many of the docstrings.

pipermerriam avatar Aug 01 '19 17:08 pipermerriam