code formatting

[haesleinhuepf]

Description

Hi Johannes @jo-mueller ,

this is just code style stuff and minor comment corrections. Could you please configure your editor that it helps you doing these things automatically, e.g. numpy-style comments?

Feel free to merge it right away if you're happy with the modifications.

Type of change

• Bug-fix
• New feature
• Breaking change
• Documentation update

References

Tests

• I adapted existing tests, because
• I added new tests to cover the code change
• All tests pass with my change

Final checks

• My change is the minimal possible work for the desired feature/fix
• I updated the documentation where necessary to cover the change

[jo-mueller]

Spyder suggests the following as a docstring template:

def test(parameter_a:int, parameter_b:float, parameter_c=False):
    """
    DESCRIPTION

    Parameters
    ----------
    parameter_a : int
        DESCRIPTION.
    parameter_b : float
        DESCRIPTION.
    parameter_c : TYPE, optional
        DESCRIPTION. The default is False.

    Returns
    -------
    parameter_a : TYPE
        DESCRIPTION.

    """
    
    
    return parameter_a

Is this suitable?

[haesleinhuepf]

Is this suitable?

Yes, that looks great