Documentación del usuario

  • En general, seguimos el Guía de estilo de documentación para desarrolladores de Google.

  • El estilo NumPy gobierna los casos donde:

    • Google no tiene orientación, o
    • Preferimos no usar el estilo de Google

    Nuestras reglas actuales:

    • Pluralizamos índice como índices en vez de índices, siguiendo el precedente de numpy.indices.
    • Por coherencia también pluralizamos matriz como matrices.
  • Los problemas gramaticales que no se abordan adecuadamente en las reglas de NumPy o Google se deciden en la sección “Gramática y uso” de la edición más reciente de la Manual de estilo de Chicago.
  • Damos la bienvenida a ser alertado a los casos que deberíamos agregar a las reglas de estilo NumPy.

Docstrings

Cuando usas Esfinge en combinación con las convenciones numpy, debe utilizar el numpydoc extensión para que sus cadenas de documentos se manejen correctamente. Por ejemplo, Sphinx extraerá el Parameters sección de su cadena de documentos y conviértala en una lista de campos. Utilizando numpydoc También evitará los errores de reStructuredText producidos por Sphinx simple cuando se encuentra con numerosas convenciones de cadenas de documentos como encabezados de sección (por ejemplo, -------------) que Sphinx no espera encontrar en cadenas de documentos.

Algunas funciones descritas en este documento requieren una versión reciente de numpydoc. Por ejemplo, el Rendimientos la sección fue agregada en numpydoc 0,6.

Está disponible en:

Tenga en cuenta que para la documentación dentro de numpy, no es necesario hacer import numpy as np al comienzo de un ejemplo. Sin embargo, algunos submódulos, como fft, no se importan de forma predeterminada y debe incluirlos explícitamente:

import numpy.fft

después de lo cual puede usarlo:

np.fft.fft2(...)

Utilice el numpydoc estándar de formato como se muestra en su ejemplo