From fce9cba1022b65324268ac399536679693ec7612 Mon Sep 17 00:00:00 2001
From: Christoph Groth <christoph.groth@cea.fr>
Date: Fri, 8 Mar 2019 15:57:04 +0100
Subject: [PATCH] clarify what dangling sites are

---
 kwant/builder.py | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/kwant/builder.py b/kwant/builder.py
index 5b89731a..8eb11c43 100644
--- a/kwant/builder.py
+++ b/kwant/builder.py
@@ -1181,7 +1181,11 @@ class Builder:
             func(sh)
 
     def eradicate_dangling(self):
-        """Keep deleting dangling sites until none are left."""
+        """Keep deleting dangling sites until none are left.
+
+        Sites are considered as dangling when less than two hoppings
+        lead to them.
+        """
         sites = list(site for site in self.H
                      if self._out_degree(site) < 2)
         for site in sites:
@@ -1243,7 +1247,11 @@ class Builder:
                 yield (tail, head), value
 
     def dangling(self):
-        """Return an iterator over all dangling sites."""
+        """Return an iterator over all dangling sites.
+
+        Sites are considered as dangling when less than two hoppings
+        lead to them.
+        """
         for site in self.H:
             if self._out_degree(site) < 2:
                 yield site
-- 
GitLab