Resultados de la búsqueda a petición "docstring"
¿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 ...
¿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 ...
Reemplazo de cadenas de documentos de Python [cerrado]
He escrito unepytext [http://epydoc.sourceforge.net/epytext.html]adescanso [http://docutils.sourceforge.net/docs/user/rst/quickref.html]convertidor de marcado, y ahora quiero convertir todas las cadenas de documentos en toda mi biblioteca de ...
¿Cómo evitar que PyCharm llene cadenas de documentos?
Si agrego una cadena de documentación a un método utilizando la comilla triple, tan pronto como escriba un espacio después de la comilla triple, PyCharm rellenará la cadena de documentación con los parámetros que toma el método y un valor de ...
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 ...
Pycharm: Auto generate `: type param:` field in docstring
Cuando creo una función con parámetros, PyCharm me ofrece crear la cadena de documentación con:param param_name: campo, que es bastante bueno. Pero también necesito agregar el:type param_name:. Entonces de eso: def foo(bar, xyz): return bar + ...
print (__ doc__) en el script Python 3
No puedo entender qué hace elprint(__doc__) hacer al comienzo de un guión, como en este ejemplo de ...
¿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, ...
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 ...