Update style docs for `list` parameters

[PicoCentauri]

PR #3482 in the main repo changed the style of parameter docs for lists. Parameters are tagged following the type hints notation of Python i.e. list[int]. This should be consistently followed in the repo.

[lilyminium]

This fix should either add a new section in the user guide, or check if there's an existing section on documentation style and edit it.

[robotjellyzone]

Hi , I would like to take this up. Is there any other guide I first need to follow for this task or anything i need to know before start working on this @lilyminium @PicoCentauri ? also, do i need to assigned to this task in order to contribute for this task?

[PicoCentauri]

@robotjellyzone, no need to assign you here. If you say you work in this everybody knows :)

I suggest adding details on the style in the section about guidelines for writing docstrings.

[robotjellyzone]

@robotjellyzone, no need to assign you here. If you say you work in this everybody knows :)

I suggest adding details on the style in the section about guidelines for writing docstrings.

@PicoCentauri can you please elaborate more regarding which section needs to be changed and exactly what I need to change?

[PicoCentauri]

First off all you could add another example in the code example

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

    Extended description of function.

    Parameters
    ----------
    arg1 : int
        Description of `arg1`
    arg2 : str
        Description of `arg2`
    arg2 : list[str]
        Description of `arg2`

And add a something like in lines of.

The parameter and attribute types should follow type hint recommendations.

[robotjellyzone]

i am done with the changes. can you please once check @PicoCentauri @lilyminium pr #200