Changeset ab23744 in sicp for apps

Timestamp:

Aug 7, 2015, 4:33:28 PM (9 years ago)

Author:

Ing. Roldan D. Vargas G <rvargas@…>

Branches:

master

Children:

5d55ba0

Parents:

4c3ab924

Message:

agregada documentación a funciones

File:

• apps/simulacion/functions.py (modified) (2 diffs)

apps/simulacion/functions.py

@@ -24 +24 @@
 
 def remove_nodos_cadena(producto_id, archivo_xml):
+    """!
+    Función que elimina los nodos de una cadena de producción de acuerdo a la selección del usuario
+
+    @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+    @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+    @date 05-08-2015
+    @param producto_id <b>{string}</b> Identificador del producto a eliminar
+    @:param archivo_xml <b>{string}</b> Nombre del archivo xml al cual se le van a eliminar los nodos
+    """
     tree = ElementTree()
     tree.parse(archivo_xml)
@@ -45 +54 @@
 
 def get_estructura_cadena_arriba(producto_id, anho):
+    """!
+    Función que obtiene la estructura de la cadena aguas arriba
+
+    @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+    @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+    @date 05-08-2015
+    @param producto_id <b>{string}</b> Identificador del producto principal o consultado
+    @param anho <b>{string}</b> Año de consulta de la cadena de producción
+    """
 
     ## Función lambda que permite obtener los insumos asociados para un producto de acuerdo al año de registro