Skip to content

Commit

Permalink
Update the doc string
Browse files Browse the repository at this point in the history
  • Loading branch information
zhubonan committed Aug 26, 2024
1 parent fbb1e1e commit 08fbe21
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion easyunfold/unfold.py
Original file line number Diff line number Diff line change
Expand Up @@ -615,10 +615,13 @@ def as_dict(self) -> dict:
output[key] = getattr(self, key)
return output

def get_kpoint_distances(self, hide_discontinuities=True):
def get_kpoint_distances(self, hide_discontinuities: bool = True):
"""
Distances between the kpoints along the path in the reciprocal space.
This does not take account of the breaking of the path.
:param hide_discontinuities: Whether to hide the discontinuities in the kpoint path.
:::{note}
The reciprocal lattice vectors includes the $2\\pi$ factor, e.g. `np.linalg.inv(L).T * 2 * np.pi`.
:::
Expand Down

0 comments on commit 08fbe21

Please sign in to comment.