Changeset ea944a3 in sicp for apps

Timestamp:

Jun 25, 2015, 11:23:38 AM (9 years ago)

Author:

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

Branches:

master

Children:

6c18e85

Parents:

87fca9d

Message:

modificaciones en documentación

File:

• apps/comun/models.py (modified) (15 diffs)

apps/comun/models.py

@@ -20 +20 @@
 
 from django.db import models
+from django.utils.translation import ugettext_lazy as _
 
 
@@ -33 +34 @@
     """
 
-    ## Atributo que registra el nombre del pais
+    ## Nombre del pais
     nombre = models.CharField(max_length=100)
 
     def __unicode__(self):
+        """!
+        Método que muestra el nombre del pais en UNICODE
+
+        @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+        @author Centro Nacional de Desarrollo e Investigación en Tecnologías Libres (CENDITEL) Nodo Mérida - Venezuela
+        @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+        @date 25-06-2015
+        @return Devuelve el nombre del pais en UNICODE
+        """
         return self.nombre
 
@@ -49 +59 @@
         @version 3.0.0
         """
+
+        ## Indica los campos bajo los cuales realizará el ordenamiento de la información
         ordering = ["nombre"]
-        verbose_name_plural = "paises"
+
+        ## Establece el nombre en plural a ser mostrado para este modelo
+        verbose_name_plural = _(u"paises")
 
 class Entidad(models.Model):
@@ -63 +77 @@
     """
 
-    ## Atributo que contiene el código INE de la entidad
+    ## Código INE de la entidad
     codigo = models.CharField(max_length=2, primary_key=True)
 
-    ## Atributo que contiene el nombre de la entidad
+    ## Nombre de la entidad
     nombre = models.CharField(max_length=50)
 
-    ## Atributo que contiene la clave foránea del pais al cual pertenece una entidad
+    # Clave foránea del pais al cual pertenece una entidad
     #pais = models.ForeignKey(Pais, null=True)
 
     def __unicode__(self):
+        """!
+        Método que muestra el nombre de la entidad en UNICODE
+
+        @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+        @author Centro Nacional de Desarrollo e Investigación en Tecnologías Libres (CENDITEL) Nodo Mérida - Venezuela
+        @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+        @date 25-06-2015
+        @return Devuelve el nombre de la entidad en UNICODE
+        """
         return self.nombre
 
@@ -85 +108 @@
         @version 3.0.0
         """
+
+        ## Indica los campos bajo los cuales realizará el ordenamiento de la información
         ordering = ["nombre"]
-        verbose_name_plural = "entidades"
+
+        ## Establece el nombre en plural a ser mostrado para este modelo
+        verbose_name_plural = _(u"entidades")
 
 class Municipio(models.Model):
@@ -99 +126 @@
     """
 
-    ## Atributo que contiene el código INE del municipio
+    ## Código INE del municipio
     codigo = models.CharField(max_length=4, primary_key=True)
 
-    ## Atributo que contiene el nombre del municipio
+    ## Nombre del municipio
     nombre = models.CharField(max_length=50)
 
-    ## Atributo que contiene la clave foránea de la entidad a la cual pertenece un municipio
+    ## Clave foránea de la entidad a la cual pertenece un municipio
     entidad = models.ForeignKey(Entidad,db_column='entidad_codigo')
 
     def __unicode__(self):
+        """!
+        Método que muestra el nombre del municipio en UNICODE
+
+        @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+        @author Centro Nacional de Desarrollo e Investigación en Tecnologías Libres (CENDITEL) Nodo Mérida - Venezuela
+        @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+        @date 25-06-2015
+        @return Devuelve el nombre del municipio en UNICODE
+        """
         return self.nombre
 
@@ -121 +157 @@
         @version 3.0.0
         """
+
+        ## Indica los campos bajo los cuales realizará el ordenamiento de la información
         ordering = ["nombre"]
 
@@ -134 +172 @@
     """
 
-    ## Atributo que contiene el código INE de la parroquia
+    ## Código INE de la parroquia
     codigo = models.CharField(max_length=6, primary_key=True)
 
-    ## Atributo que contiene el nombre de la parroquia
+    ## Nombre de la parroquia
     nombre = models.CharField(max_length=80)
 
-    ## Atributo que contiene la clave foránea del municipio al cual pertenece una parroquia
+    ## Clave foránea del municipio al cual pertenece una parroquia
     municipio = models.ForeignKey(Municipio, db_column='municipio_codigo')
 
     def __unicode__(self):
+        """!
+        Método que muestra el nombre de la parroquia en UNICODE
+
+        @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+        @author Centro Nacional de Desarrollo e Investigación en Tecnologías Libres (CENDITEL) Nodo Mérida - Venezuela
+        @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+        @date 25-06-2015
+        @return Devuelve el nombre de la parroquia en UNICODE
+        """
         return self.nombre
 
@@ -156 +203 @@
         @version 3.0.0
         """
+
+        ## Indica los campos bajo los cuales realizará el ordenamiento de la información
         ordering = ["nombre"]
 
@@ -170 +219 @@
     """
 
-    ## Atributo que contiene el código ciiu
+    ## Código Industrial Internacional Uniforme (CIIU)
     codigo = models.CharField(max_length=5, primary_key=True)
 
-    ## Atributo que contiene la descripción del Código Industrial Internacional Uniforme (CIIU)
+    ## Descripción del Código Industrial Internacional Uniforme (CIIU)
     descripcion = models.CharField(max_length=200)
 
-    ## Atributo que contiene los niveles del CIIU
+    ## Niveles del Código Industrial Internacional Uniforme (CIIU)
     nivel = models.SmallIntegerField()
 
-    ## Atributo que contiene el CIIU de referencia
+    ## Código Industrial Internacional Uniforme (CIIU) de referencia
     referencia = models.CharField(max_length=5)
 
     def __unicode__(self):
+        """!
+        Método que muestra el código CIIU con su descripción en UNICODE
+
+        @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+        @author Centro Nacional de Desarrollo e Investigación en Tecnologías Libres (CENDITEL) Nodo Mérida - Venezuela
+        @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+        @date 25-06-2015
+        @return Devuelve el código CIIU con su descripción en UNICODE
+        """
         return self.codigo + '-' + self.descripcion
 
@@ -195 +253 @@
         @version 3.0.0
         """
-        verbose_name = "Código Ciuu"
-        verbose_name_plural = "Código Ciiu"
+
+        ## Establece el nombre en singular a ser mostrado para este modelo
+        verbose_name = _(u"Código Ciuu")
+
+        ## Establece el nombre en plural a ser mostrado para este modelo
+        verbose_name_plural = _(u"Código Ciiu")
 
     def cuantos_digitos(self):
+        """!
+        Método que obtiene información sobre el número de dígitos que contiene el Código CIIU
+
+        @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+        @author Centro Nacional de Desarrollo e Investigación en Tecnologías Libres (CENDITEL) Nodo Mérida - Venezuela
+        @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+        @date 25-06-2015
+        @return Devuelve el número de dígitos que contiene el Código CIIU
+        """
         return len(self.codigo)
 
@@ -213 +284 @@
     """
 
-    ## Atributo que contiene el Código Arancelario
+    ## Código Arancelario
     codigo = models.CharField(max_length=13, primary_key=True)
 
-    ## Atributo que contiene la sección del código arancelario
+    ## Sección del código arancelario
     seccion = models.SmallIntegerField()
 
-    ## Atributo que contiene el capítulo del código arancelario
+    ## Capítulo del código arancelario
     capitulo = models.SmallIntegerField()
 
-    ## Atributo que contiene la descripción del código arancelario
+    ## Descripción del código arancelario
     descripcion = models.CharField(max_length=400)
 
-    ## Atributo que contiene la descripción de referencia del código arancelario
+    ## Descripción de referencia del código arancelario
     descripcion_ref = models.CharField(max_length=400)
 
     def __unicode__(self):
+        """!
+        Método que muestra el código arancelario en UNICODE
+
+        @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+        @author Centro Nacional de Desarrollo e Investigación en Tecnologías Libres (CENDITEL) Nodo Mérida - Venezuela
+        @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+        @date 25-06-2015
+        @return Devuelve el código arancelario en UNICODE
+        """
         return self.codigo
 
@@ -241 +321 @@
         @version 3.0.0
         """
-        verbose_name = "Código Arancelario"
-        verbose_name_plural = "Código Arancelario"
+
+        ## Establece el nombre en singular a ser mostrado para este modelo
+        verbose_name = _(u"Código Arancelario")
+
+        ## Establece el nombre en plural a ser mostrado para este modelo
+        verbose_name_plural = _(u"Código Arancelario")
 
 
@@ -256 +340 @@
     """
 
-    ## Atributo que contiene el nombre de la unidad de medida
+    ## Nombre de la unidad de medida
     nombre = models.CharField(max_length=100)
 
     def __unicode__(self):
+        """!
+        Método que muestra el nombre de la unidad de medida en UNICODE
+
+        @author Ing. Roldan Vargas (rvargas at cenditel.gob.ve)
+        @author Centro Nacional de Desarrollo e Investigación en Tecnologías Libres (CENDITEL) Nodo Mérida - Venezuela
+        @copyright <a href='http://www.gnu.org/licenses/gpl-2.0.html'>GNU Public License versión 2 (GPLv2)</a>
+        @date 25-06-2015
+        @return Devuelve el nombre de la unidad de medida en UNICODE
+        """
         return self.nombre
 
@@ -272 +365 @@
         @version 3.0.0
         """
-        verbose_name = "Unidad de Medida"
-        verbose_name_plural = "Unidades de Medida"
+
+        ## Establece el nombre en singular a ser mostrado para este modelo
+        verbose_name = _(u"Unidad de Medida")
+
+        ## Establece el nombre en plural a ser mostrado para este modelo
+        verbose_name_plural = _(u"Unidades de Medida")