From 828fe36884103af8ce14ba9630c4b531f8f76c71 Mon Sep 17 00:00:00 2001
From: Christoph Groth <christoph.groth@cea.fr>
Date: Fri, 16 Oct 2015 11:45:50 +0200
Subject: [PATCH] silence warnings with numpydoc 0.4
---
kwant/lattice.py | 22 ++++++++++------------
1 file changed, 10 insertions(+), 12 deletions(-)
diff --git a/kwant/lattice.py b/kwant/lattice.py
index 13ff116c..13e93a78 100644
--- a/kwant/lattice.py
+++ b/kwant/lattice.py
@@ -70,12 +70,6 @@ class Polyatomic(object):
sublattices are obtained by appending their number to the name of the
lattice.
- Attributes
- ----------
- prim_vecs : 2d tinyarray of floats
- ``prim_vecs[i]`` is the `i`-th primitive basis vector of the lattice
- Sublattices belonging to this lattice.
-
Raises
------
ValueError
@@ -354,6 +348,12 @@ class Polyatomic(object):
@property
def prim_vecs(self):
+ """(sequence of vectors) Primitive vectors
+
+ `prim_vecs[i]`` is the `i`-th primitive basis vector of the lattice
+ displacement of the lattice origin from the real space coordinates
+ origin.
+ """
return np.array(self._prim_vecs)
def vec(self, int_vec):
@@ -394,19 +394,17 @@ class Monatomic(builder.SiteFamily, Polyatomic):
Parameters
----------
- prim_vecs : 2d array-like of floats
+ prim_vecss : 2d array-like of floats
Primitive vectors of the Bravais lattice.
+
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
+ ``offset`` : vector
+ Displacement of the lattice origin from the real space coordinates origin
"""
def __init__(self, prim_vecs, offset=None, name=''):
--
GitLab