From 056c312a8461e030f66af77eaaafa4124ccf347f Mon Sep 17 00:00:00 2001
From: Joseph Weston <joseph.weston08@gmail.com>
Date: Tue, 29 Aug 2017 13:34:39 +0200
Subject: [PATCH] refer to PropagatingModes docstring from physics.leads.modes
There is no point in repeating the docstring in 2 places, though we
leave in the explanation of what this means in the "simplest case", i.e.
lowest modes first, for clarity.
---
kwant/physics/leads.py | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/kwant/physics/leads.py b/kwant/physics/leads.py
index 22ef7717..61883c43 100644
--- a/kwant/physics/leads.py
+++ b/kwant/physics/leads.py
@@ -1034,12 +1034,11 @@ def modes(h_cell, h_hop, tol=1e6, stabilization=None, *,
Notes
-----
- The propagating modes are sorted according to the longitudinal component of
- their k-vector, with incoming modes having k sorted in descending order,
- and outgoing modes having k sorted in ascending order. In simple cases
- where bands do not cross, this ordering corresponds to "lowest modes
- first". In general, however, it is necessary to examine the band structure
- -- something this function is not doing by design.
+ The sorting of the propagating modes is fully described in the
+ documentation for `~kwant.physics.PropagatingModes`. In simple cases where
+ bands do not cross, this ordering corresponds to "lowest modes first". In
+ general, however, it is necessary to examine the band structure --
+ something this function is not doing by design.
Propagating modes with the same momentum are orthogonalized. All the
propagating modes are normalized by current.
--
GitLab