Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Add missing docstrings #1882
What was wrong?
We have a bunch of types in our docs that are lacking docstrings. I believe having at least some docstring per public API is the lowest bar of requirement before we can cut a beta.
How was it fixed?
Added at least some docstring for every single public API.
Imperative present tense is being used for the docstrings.
For methods, it should rhyme with IT WILL:
def get_block: """ Return the block at the tip of the chain """
For methods, it should rhyme with IT IS:
class SchemaAPI(ABC): """ A class representing a database schema that maps values to lookup keys. """
Cute Animal Picture