introduccion¶
Ejemplos para documentar en Sphinx.
Acá se documenta al archivo (script o módulo).
En la sección Attributes se pueden documentar a las variables globales (las definidas afuera de todo).
En la documentación de variables o argumentos, opcionalmente se pueden definir los tipos, ya sea en los docstrings o en los “Type Hints” (PEP 484 y PEP 526).
-
introduccion.
vehiculos
¶ Descripción de la variable
-
introduccion.
colores
¶ List[str] – Indico que se trata de una lista de strings.
-
introduccion.
insertar1
(string, letra, posicion)[fuente]¶ Inserta una letra en un string en la posición dada.
-
introduccion.
insertar2
(string, letra, posicion)[fuente]¶ Inserta una letra en un string en la posición dada.
Parámetros: - string – Cadena de caracteres en la cual insertar la letra.
- letra – Letra a insertar.
- posicion – Posición en la cual insertar la letra. 0 es la primer posición.
Devuelve: Nueva cadena de caracteres igual a la original pero con la letra en la posición dada.
-
introduccion.
insertar3
(string, letra, posicion)[fuente]¶ Inserta una letra en un string en la posición dada.
Parámetros: Devuelve: Nueva cadena de caracteres igual a la original pero con la letra en la posición dada.
Tipo del valor devuelto:
-
introduccion.
insertar4
(string: str, letra: str, posicion: int) → str[fuente]¶ Inserta una letra en un string en la posición dada.
Parámetros: - string – Cadena de caracteres en la cual insertar la letra.
- letra – Letra a insertar.
- posicion – Posición en la cual insertar la letra. 0 es la primer posición.
Devuelve: Nueva cadena de caracteres igual a la original pero con la letra en la posición dada.
-
introduccion.
paises
= ['argentina', 'brasil', 'uruguay']¶ List[str] – Puedo documentar a la variable acá también.