Saltar al contenido

Python y Sphinx: lista de viñetas en una cadena de documentos de estilo de Google de varias líneas

Mantén la atención porque en este escrito encontrarás el arreglo que buscas.Este artículo fue aprobado por nuestros especialistas para garantizar la calidad y exactitud de nuestro post.

Solución:

Puede romper la línea con viñetas como desee. Simplemente alinee la continuación con el texto de las líneas anteriores como:

- give a visual representation of that geography
- give a visual representation of the distance matrix
- give a visual representation of a configuration, a configuration being the
  repartition of some or all cities in pools

La solución de @Stephen Rauch fue la perfecta. Solo quería agregar que también funciona para listas sin viñetas. Tuve un problema similar con los comentarios de argumentos de funciones o métodos. Por ejemplo:

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)

La última línea es demasiado larga.

Sin embargo, un salto de línea del “mismo nivel de sangría” simplemente rompe la documentación del método agradable de la esfinge:

    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)

Documentación mal construida

Pero romper la línea con una identificación funciona bien.

    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)

Documentación bien construida

Aquí tienes las comentarios y calificaciones

¡Haz clic para puntuar esta entrada!
(Votos: 0 Promedio: 0)



Utiliza Nuestro Buscador

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *