Documentation

Construct the documentation for the release of the package.

pymf/tb/utils.py

@@ -14,7 +14,7 @@ def generate_guess(
     Parameters
     ----------
     tb_keys :
-       List of tight-binding dictionary keys the guess contains.
+       List of hopping vectors (tight-binding dictionary keys) the guess contains.
     ndof :
         Number internal degrees of freedom within the unit cell.
     scale :
@@ -22,7+22,7 @@
     Returns
     -------
     :
         Hermitian guess tight-binding dictionary.
     """
     guess = {}
     for vector in tb_keys: