Resultados de la búsqueda a petición "docstring"
¿Cómo documento: rtype: para una función que devuelve múltiples tipos de datos posibles? [duplicar
Esta pregunta ya tiene una respuesta aquí: Cómo especificar múltiples tipos de retorno usando sugerencias de tipo [/questions/33945261/how-to-specify-multiple-return-types-using-type-hints] 2 respuestas En una cadena de documentos de Python, ...
Configuración de la cadena de documentos a una expresión dentro de la definición
Me gustaría configurar el
Genere automáticamente documentación de Wiki de GitHub a partir de cadenas de documentos de Python
El título lo dice todo. Lo que imagino es tener cadenas de documentos para todos mis módulos, clases y funciones, y de alguna manera navegar el documento a través de github (wiki?). Además, el documento debe estar sincronizado con el último ...
¿Cómo escribir cadenas de documentos significativas?
¿Qué, en tu opinión, es una cadena de documentos significativa? ¿Qué esperas que se describa allí? Por ejemplo, considere esta clase de Python__init__: def __init__(self, name, value, displayName=None, matchingRule="strict"): """ name - field ...
Cómo documentar el código Python con doxygen [cerrado]
Me gusta doxygen para crear documentación de código C o PHP. Tengo un próximo proyecto de Python y creo recordar que Python no tiene/* .. */ comentarios, y también tiene su propia facilidad de autodocumentación que parece ser la forma pitónica ...
¿Cómo configuro programáticamente la cadena de documentación?
Tengo una función de contenedor que devuelve una función. ¿Hay alguna manera de establecer mediante programación la cadena de documentación de la función devuelta? Si pudiera escribir a__doc__ Yo haría lo siguiente: def wrapper(a): def ...
¿Cómo puedo hacer que los atributos de objetos de documento de Python / Sphinx solo se declaren en __init__?
Tengo clases de Python con atributos de objeto que solo se declaran como parte de la ejecución del constructor, así: class Foo(object): def __init__(self, base): self.basepath = base temp = [] for run in os.listdir(self.basepath): if ...
¿Qué significa estos formatos en la cadena de documentación de twisted?
En el código fuente de twisted, muchas cadenas de documentación contienen formatos como este: L {xxx} o C {xxx} o una línea que comienza con una '@',...