Documentation update for ABC base classes #2064
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was wrong?
FIX: #1806
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 was it fixed?
Added docstrings for non-documented abstract methods in
abc.py.Did not find any docstring that refer to the old classes. This was probably fixed in other PRs since this issue dates from a long time ago.
Todo:
Cute Animal Picture