Update docstrings of Cosymlib class

GrupEstructuraElectronicaSimetria · Dec 28, 2020 · 7c21403 · 7c21403
1 parent a712112
commit 7c21403
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/cosymlib/__init__.py b/cosymlib/__init__.py
@@ -27,7 +27,7 @@ class Cosymlib:
     """
     Main cosymlib class
 
-    :param structures: List of Geometry or Molecule type objects
+    :param structures: List of :class:`~cosymlib.molecule.geometry.Geometry` or :class:`~cosymlib.molecule.Molecule` type objects
     :type structures: list
     :param ignore_atoms_labels: Ignore atomic element labels is symmetry calculations
     :type ignore_atoms_labels: bool
@@ -92,7 +92,7 @@ def get_geometries(self):
         """
         Get the geometries
 
-        :return: List of Geometry objects
+        :return: List of :class:`~cosymlib.molecule.geometry.Geometry` objects
         :rtype: list
         """
         return [mol.geometry for mol in self._molecules]
@@ -111,7 +111,7 @@ def molecules(self):
         """
         Get the molecules
 
-        :return: List of Molecule objects
+        :return: List of :class:`~cosymlib.molecule.Molecule` objects
         :rtype: list
         """
         return self._molecules

diff --git a/cosymlib/molecule/__init__.py b/cosymlib/molecule/__init__.py
@@ -46,10 +46,22 @@ def name(self):
 
     @property
     def geometry(self):
+        """
+        Get the geometry
+
+        :return: The geometry
+        :rtype: Geometry
+        """
         return self._geometry
 
     @property
     def electronic_structure(self):
+        """
+        Get the electronic structure
+
+        :return: The electronic structure
+        :rtype: ElectronicStructure
+        """
         if self._electronic_structure is None:
             warn('Warning: Electronic structure auto generated from extended Huckel')
             eh = ExtendedHuckel(self.geometry)