Verified Commit 39565ebd authored by Adel Kara Slimane's avatar Adel Kara Slimane
Browse files

Improve docstring in EnergySiteValidator

parent c37f0125
......@@ -28,7 +28,7 @@ class EnergySiteValidator:
r"""
A class that tells if energy related quantities can be calculated on a given site or hopping.
In principle any site/hopping can be used, though (t)Kwant's implementation doesn't enable accessing the wave function on lead sites, so any energy operator that requires the wave function on neighboring sites cannot be calculated when the latter are lead sites.
In principle any site/hopping can be used, though (t)Kwant's implementation doesn't enable accessing the wave function on lead sites. Thus, if an energy operator is calculated on a site/hopping that involves lead sites as neighbors it would return wrong results (energy operators test against that use case to throw an exception).
Parameters
----------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment