Как набрать список int в numpydoc

Question

Как правильно набрать list из int в numpydo c строке документа.

Допустим ли этот синтаксис, например, int[], например?

def my_function(numbers):
    """
    Parameters
    ----------
    numbers : int[]
        List of numbers
    """

    return numbers

Answer 1

Согласно numpydo c руководству по документации , в разделе Разделы - 4.Параметры , вы найдете пример того, как документировать list of str, поэтому просто измените его на list of int.

Причина, по которой документ явно указан как тип list of int, а не просто int [], заключается в том, что квадратные скобки [] в python (часто называемый «индексированием массива») указывает, что объект можно индексировать, разрезать и повторять. Синтаксис в квадратных скобках, сам по себе, не различает guish, если вы имеете дело с массивом или списком, за исключением первоначально при создании экземпляра объекта. Как показывают python документы, квадратные скобки с конструктором list([iterable]) указывают, что объект внутри скобок должен быть только итеративным.

Это становится очевидным, если поставить рядом:

def my_function_one(numbers):
    """
    Parameters
    ----------
    numbers : int[]
        List of numbers
    """

    return numbers


def my_function_two(numbers):
    """
    Parameters
    ----------
    numbers : list of int
        List of numbers
    """

    return numbers

Результат, чтобы вы могли сравнить два: