Source code for src.ska_python_skeleton.example

# -*- coding: utf-8 -*-

# """Define function placeholders and
# test function examples."""


# TODO: Replace all the following code with the
# desired functionality for the package
def function_example():
    """Example: function outside of a class"""


# TODO: Replace all the following code with the d
# desired functionality for the package

[docs]
class SKA:
    """Define class, methods etc"""

    something = 0


[docs]
    def example(self):
        """Example: Define non return function
        for subsequent test."""



[docs]
    def example_2(self):
        """Example: Define function for subsequent test with
        specific return value."""
        return 2