From d23664ac5fdd9fe5fed204773cdc70e3bdc36940 Mon Sep 17 00:00:00 2001
From: Michael Wimmer <wimmer@lorentz.leidenuniv.nl>
Date: Tue, 3 Sep 2013 13:46:48 +0200
Subject: [PATCH] add documentation to attributes of lattices
---
kwant/lattice.py | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/kwant/lattice.py b/kwant/lattice.py
index 3f99e7a..470ff68 100644
--- a/kwant/lattice.py
+++ b/kwant/lattice.py
@@ -69,6 +69,8 @@ class Polyatomic(object):
Attributes
----------
+ prim_vecs : sequence of vectors
+ ``prim_vecs[i]`` is the `i`-th primitive basis vector of the lattice
sublattices : list of `Monatomic`
Sublattices belonging to this lattice.
@@ -381,6 +383,14 @@ class Monatomic(builder.SiteFamily, Polyatomic):
offset : vector of floats
Displacement of the lattice origin from the real space
coordinates origin.
+
+ Attributes
+ ----------
+ offset : vector
+ Displacement of the lattice origin from the real space
+ coordinates origin.
+ prim_vecs : sequence of vectors
+ ``prim_vecs[i]`` is the `i`-th primitive basis vector of the lattice
"""
def __init__(self, prim_vecs, offset=None, name=''):
--
GitLab