logo

... docs: docstrings



Notes

Note

Note for in these videos we're using these packages/versions:

mkdocs==1.1
mkdocs-material==4.6.3
mkdocstrings==0.8.0

That said, this is the docstring on our Clumper class at the time of making this video.

class Clumper:
    """
    This object adds methods to a list of dictionaries that make
    it nicer to explore.

    ...
    """

You can see how it gets rendered here.

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



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