From 53a12b1378c4116e95ec65b159e9f61ba4c1910e Mon Sep 17 00:00:00 2001
From: Joseph Weston <joseph.weston08@gmail.com>
Date: Fri, 14 Jul 2017 09:47:46 +0200
Subject: [PATCH] correct documentation of PropagatingModes
The alleged mode ordering was the opposite of the true ordering.
The true ordering corresponds to "lowest modes first" when there are
no band crossing.
---
kwant/physics/leads.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/kwant/physics/leads.py b/kwant/physics/leads.py
index 5849f185..9f555b8e 100644
--- a/kwant/physics/leads.py
+++ b/kwant/physics/leads.py
@@ -53,8 +53,8 @@ class PropagatingModes(object):
=====
The sort order of all the three arrays is identical. The first half of the
modes have negative velocity, the second half have positive velocity. The
- modes with negative velocity are ordered from larger to lower momenta, the
- modes with positive velocity vice versa.
+ modes with negative velocity are ordered by increasing momentum, the
+ modes with positive velocity are ordered by decreasing momentum.
The first dimension of `wave_functions` corresponds to the orbitals of all
the sites in a unit cell, the second one to the number of the mode. Each
--
GitLab