Skip to content
Karolina Finc edited this page Feb 7, 2020 · 2 revisions

Welcome to the fmridenoise wiki!

We are happy to have you on board and grateful for every (even small) improvement to the software! Here we present some guidance for contributing to fMRIDenoise.

Docstrings style

For consistency, we ask all contributors to document their code using docstrings Google style.

Example function:

def func(arg1, arg2):
    """Summary line.

    Extended description of function.

    Args:
        arg1 (int): Description of arg1
        arg2 (str): Description of arg2

    Returns:
        bool: Description of return value

    """
    return True
Clone this wiki locally