Skip to content

Example

This is example documentation page for example code I hope this will work in some day. But not now

Example

Creates example code with comments.

This documentation should be shown in example page.

If this doesn't shown there is some error I need to handle

Source code in src/example1.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class Example():
    """
    Creates example code with comments.

    This documentation should be shown in example page.

    If this doesn't shown there is some error I need to handle


    """

    def __init__():
        """
        This a small code do nothing
        """


    def generate_parameters():
        """
        And this do nothing, but documentation still should appear
        """


    def get_next_samples():
        """
        Gets the next batch of parameter combinations.

        """



    def register_future():
        """ Doesn't matter for random sampler TODO: Probably? """
        return None

__init__()

This a small code do nothing

Source code in src/example1.py 
12
13
14
15
def __init__():
    """
    This a small code do nothing
    """

generate_parameters()

And this do nothing, but documentation still should appear

Source code in src/example1.py 
18
19
20
21
def generate_parameters():
    """
    And this do nothing, but documentation still should appear
    """

get_next_samples()

Gets the next batch of parameter combinations.

Source code in src/example1.py 
24
25
26
27
28
def get_next_samples():
    """
    Gets the next batch of parameter combinations.

    """

register_future()

Doesn't matter for random sampler TODO: Probably?

Source code in src/example1.py 
32
33
34
def register_future():
    """ Doesn't matter for random sampler TODO: Probably? """
    return None