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.

Sign up for GitHub

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

Jump to bottom

Documentation update for ABC base classes #1806

Open
pipermerriam opened this issue Aug 1, 2019 · 1 comment · May be fixed by #2064
Open

Documentation update for ABC base classes #1806

pipermerriam opened this issue Aug 1, 2019 · 1 comment · May be fixed by #2064
Labels
Good First Issue

Comments

@pipermerriam
Copy link
Member

What is wrong?

Previous to #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
Copy link
Member Author

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

@simon-saliba simon-saliba linked a pull request May 27, 2022 that will close this issue
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Good First Issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documentation update for ABC base classes simon-saliba/py-evm
1 participant
@pipermerriam