| 1 |
""" |
| 2 |
Module for testing the autodocsumm |
| 3 |
---------------------------------- |
| 4 |
|
| 5 |
Just a dummy module with some class definitions |
| 6 |
""" |
| 7 |
|
| 8 |
|
| 9 |
#: to test if the data is included |
| 10 |
test_data = None |
| 11 |
|
| 12 |
|
| 13 |
def test_func(): |
| 14 |
"""Test if function is contained in autosummary""" |
| 15 |
pass |
| 16 |
|
| 17 |
|
| 18 |
class Class_CallTest(object): |
| 19 |
"""A class defining a __call__ method""" |
| 20 |
|
| 21 |
def __get__(self, instance, owner): |
| 22 |
return self |
| 23 |
|
| 24 |
def __set__(self, instance, value): |
| 25 |
"""Actually not required. We just implement it to ensure the python |
| 26 |
"help" function works well""" |
| 27 |
pass |
| 28 |
|
| 29 |
def __call__(self, a, b): |
| 30 |
""" |
| 31 |
Caller docstring for class attribute |
| 32 |
|
| 33 |
Parameters |
| 34 |
---------- |
| 35 |
a: any |
| 36 |
dummy parameter |
| 37 |
b: anything else |
| 38 |
second dummy parameter""" |
| 39 |
pass |
| 40 |
|
| 41 |
|
| 42 |
class TestClass(object): |
| 43 |
"""Class test for autosummary""" |
| 44 |
|
| 45 |
def test_method(self): |
| 46 |
"""Test if the method is included""" |
| 47 |
pass |
| 48 |
|
| 49 |
#: to test if the class attribute is included |
| 50 |
test_attr = None |
| 51 |
|
| 52 |
class_caller = Class_CallTest() |
| 53 |
|
| 54 |
#: data to be included |
| 55 |
large_data = 'Should be included' |
| 56 |
|
| 57 |
#: data to be skipped |
| 58 |
small_data = 'Should be skipped' |
| 59 |
|
| 60 |
|
| 61 |
#: data to be skipped |
| 62 |
large_data = 'Should also be skipped' |
| 63 |
|
| 64 |
#: data to be included |
| 65 |
small_data = 'Should also be included' |