4.1. oastools package

4.1.2. Submodules

4.1.3. oastools.core module

oastools

Author:Name <email>
Date:2019-8-28
Copyright:2019, Bilal Shaikh
License:MIT
class oastools.core.ExampleClass(arg_1, arg_2, kwarg_1=None, kwarg_2=None)

Bases: object

Descipton of ExampleClass

attr_1

description of attr_1

Type:type of attr_1
attr_2

description of attr_2

Type:type of attr_2
...
method_1(arg_1, arg_2, kwarg_1=None, kwarg_2=None)

Description of method_1

Parameters:
  • arg_1 (type of arg_1) – description of arg_1
  • arg_2 (type of arg_2) – description of arg_2
  • kwarg_1 (type of kwarg_1, optional) – description of kwarg_1
  • kwarg_2 (type of kwarg_2, optional) – description of kwarg_2
  • ..
Returns:

description of return value

Return type:

type of return value

Raises:

:obj:`type of raised exception(s)` – description of raised exceptions

4.1.4. Module contents