Documentation of shape comparison metric doesn't match state in code

[ronald-jaepel]

The documentation for the shape comparison metric has

class CADETProcess.comparison.Shape(
    reference, components=None, use_total_concentration=False, use_total_concentration_components=True, 
    start=None, end=None, transform=None, only_transforms_array=True, 
    resample=True, smooth=False, normalize=False
    )

while the code has

def __init__(
        self, *args,
        use_derivative=True, normalize_metrics=True, normalization_factor=None,
        include_height=True,
        **kwargs):

Is it possible to read the arguments of the __init__ function into the documentation?

[schmoelder]

I assume this is because it delegates the *args / **kwargs to the super.__init__() but when building the signature in the Structure, it might miss additional arguments from daughter classes; see here:

https://github.com/fau-advanced-separations/CADET-Process/blob/dev/CADETProcess/dataStructure/dataStructure.py#L403

In any case, improving the docstrings of wraped objects if definitely something we should strive for.