Skip to content

classes

This is the first line in the doc-string of module classes.

Here's a link to the more interesting module actions.

Class1

This is the first line in the doc-string of Class1.

It is part of module classes.

Source code in package/classes.py
class Class1:
    """
    This is the first line in the doc-string of `Class1`.

    It is part of module [`classes`][package.classes].
    """

    def __init__(self):
        """This is the constructor of `Class1`."""

    def action(self, do='nothing'):
        """This is a method of `Class1`."""

__init__(self) special

This is the constructor of Class1.

Source code in package/classes.py
def __init__(self):
    """This is the constructor of `Class1`."""

action(self, do='nothing')

This is a method of Class1.

Source code in package/classes.py
def action(self, do='nothing'):
    """This is a method of `Class1`."""

Class2

This is the first line in the doc-string of Class2.

It is also part of module classes.

Source code in package/classes.py
class Class2:
    """
    This is the first line in the doc-string of `Class2`.

    It is also part of module [`classes`][package.classes].
    """

    def __init__(self):
        """This is the constructor of `Class2`."""

    def action(self, do=None):
        """This is a method of `Class2`."""

__init__(self) special

This is the constructor of Class2.

Source code in package/classes.py
def __init__(self):
    """This is the constructor of `Class2`."""

action(self, do=None)

This is a method of Class2.

Source code in package/classes.py
def action(self, do=None):
    """This is a method of `Class2`."""