.. Docstring tutorial example
.. Author: Benjamin Vandendriessche

.. STATUS: snippet

.. code-block:: Python

    """**python_module.py**: What is the purpose of the module in one sentence."""

    from datetime import datetime


    class SomeClass:
        """What does this class do.

        (optional) An additional paragraph with relevant information.
        """

        def __init__(self, arg):
            self.arg = arg

        def some_function(self, var1, var2):
            """What does it do in one sentence.

            (optional) An additional paragraph with relevant information.

            Arguments:
                var1 (type): input argument does something
                var2 (type): input argument does something else

            Returns:
                (tuple): tuple containing:

                    - msg (str): a string
                    - t (datetime): the current time
            """

            msg = print('Hello World')

            # This is a comment
            t = datetime.now()

            return msg, t  # Another oneline comment, separated by 2 spaces


    def some_other_function(var1, var2):
        """Rinse and repeat."""