From 7669a3f983a0e1f0a1ec7dc48bd3ac5a073f30d7 Mon Sep 17 00:00:00 2001 From: Christoph Groth <christoph.groth@cea.fr> Date: Thu, 29 Nov 2012 11:16:42 +0100 Subject: [PATCH] fix builder.Site docstring --- kwant/builder.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/kwant/builder.py b/kwant/builder.py index bf84586e..8bddf07e 100644 --- a/kwant/builder.py +++ b/kwant/builder.py @@ -26,9 +26,10 @@ class Site(tuple): Parameters ---------- group : an instance of `SiteGroup` - the 'type' of the site. + The 'type' of the site. tag : a hashable python object - the personal idenifier of the site e. g. its number. + The unique identifier of the site within the site group, typically a + vector of integers. Attributes ---------- @@ -38,7 +39,7 @@ class Site(tuple): Raises ------ ValueError - If ``tag`` is not a proper tag for ``group``. + If `tag` is not a proper tag for `group`. Notes ----- -- GitLab