Решение от @ Стивена Рауха было идеальным.Я просто хотел добавить, что это также работает для не маркированных списков.У меня была похожая проблема с комментариями для аргументов функций или методов.Например:
def permute_array(arr, seq):
""" Function to "square permute" a 2D array
This function's purpose is to enable distance matrices permutations. That
is, for example, permute both lines and columns of the array so as to
reorder a distance matrix.
Args:
arr (numpy array): the array to permute. It should be square of size n.
seq (iterable of int): a permutation of range(n) (should be of length n and contain every integer from 0 to n-1)
Последняя строка слишком длинная.
Однако разрыв строки "с тем же уровнем отступа" просто нарушает документацию по методу sphinx:
Args:
arr (numpy array): the array to permute. It should be square of size n.
seq (iterable of int): a permutation of range(n) (should be of length n
and contain every integer from 0 to n-1)
Плохо построенная документация
Но разрыв строки с помощью отступа просто отлично работает.
Args:
arr (numpy array): the array to permute. It should be square of size n.
seq (iterable of int): a permutation of range(n) (should be of length n
and contain every integer from 0 to n-1)
Прекрасно составленная документация