logo

... docs.


Documentation is more important than most people are willing to admit. If you want your project to be used though, you to invest in it. As a bonus, you might also be able to get some good unit tests for free too. In this series of video's we'll highlight how we've set up documentation for clumper.


Notes

When you've got a function like this:

def some_func(a, b):
    """
    This function adds two variables together.
    """
    return a + b

Then you can inspect the docstring by querying:

some_func.__doc__

This enables us to parse the docstring and to do whatever we want with it.


Feedback? See an issue? Something unclear? Feel free to mention it here.

If you want to be kept up to date, consider getting the newsletter.