Skip to content

Instantly share code, notes, and snippets.

View doolio's full-sized avatar

Niall Dooley doolio

  • 21:17 (UTC +01:00)
View GitHub Profile
# -*- coding: utf-8 -*-
"""Demonstrate high quality docstrings.
Module-level docstrings appear as the first "statement" in a module. Remember,
that while strings are regular Python statements, comments are not, so an
inline comment may precede the module-level docstring.
After importing a module, you can access this special string object through the
``__doc__`` attribute; yes, it's actually available as a runtime attribute,
despite not being given an explicit name! The ``__doc__`` attribute is also