[DOC] Fix Linting issue and update docstring to Numpy Style By Module

[fnhirwa]

Describe the issue linked to the documentation

This is an issue for tracking the fixation of linting errors in the codebase and updating the docstring to the proper numpy style:

From

def add(a, b):
    """
    Add two numbers together

    Args:
        a (int): The first number
        b (int): The second number

    Returns:
        int: The sum of the two numbers
    """
    pass

To

def add(a, b):
    """
    Add two numbers together

    Parameters
    ----------
    a : int
        The first number
    b : int
        The second number

    Returns
    -------
    int
        The sum of the two numbers
    """
    pass

Suggest a potential alternative/fix

Subsetting the issue as the changes are expected to be huge for review.

• data
• metrics
• models
• map
• deeper
• beats
• nhits
• nn
• rnn
• tft
• tide
• utils
• tests

[yarnabrina]

If existing codebase followsgoogle style, can we not continue that? It can be configured easily I think.

https://docs.astral.sh/ruff/settings/#lint_pydocstyle_convention

[fnhirwa]

If existing codebase followsgoogle style, can we not continue that? It can be configured easily I think.

https://docs.astral.sh/ruff/settings/#lint_pydocstyle_convention

I would prefer the numpy style, as the implementations seem to be more detailed, and the numpy style works well for the case.

https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html

Otherwise, we would need to increase the length of the line in our linter because the google style uses indentation whereas numpy uses underlines.

Google would be the best choice for short docstring, but for docstring where we need Examples Numpy style is the best choice. And I am sure that most of our contributors work with scientific libraries, which will make it easy for them to write the docstrings. An Example here in this commit @fkiraly already used the numpy style #1746