From 614a4397ee5f40cb02c8b40bae59f4a46c92a86a Mon Sep 17 00:00:00 2001
From: Anton Akhmerov <anton.akhmerov@gmail.com>
Date: Wed, 24 Apr 2013 15:06:00 -0400
Subject: [PATCH] remove double entry for Site.pos, improve Site.family and
.tag docstrings
---
kwant/builder.py | 11 ++++-------
1 file changed, 4 insertions(+), 7 deletions(-)
diff --git a/kwant/builder.py b/kwant/builder.py
index 4c945d9b..424d5e55 100644
--- a/kwant/builder.py
+++ b/kwant/builder.py
@@ -39,11 +39,6 @@ class Site(tuple):
The unique identifier of the site within the site family, typically a
vector of integers.
- Attributes
- ----------
- pos : sequence of numbers
- The real-space position of the site. Used for plotting, for example.
-
Raises
------
ValueError
@@ -60,8 +55,10 @@ class Site(tuple):
"""
__slots__ = ()
- family = property(operator.itemgetter(0))
- tag = property(operator.itemgetter(1))
+ family = property(operator.itemgetter(0),
+ doc="The site family to which the site belongs.")
+ tag = property(operator.itemgetter(1), doc="The tag of the site.")
+
def __new__(cls, family, tag, _i_know_what_i_do=False):
if _i_know_what_i_do:
--
GitLab