small documentation fixes

TODO

@@ -6,9 +6,6 @@ Roughly in order of importance.                                     -*-org-*-
 
 * Add calculation of current density
 
-* Consider making the b parameter of _solve_linear_sys a matrix instead of a
-  list of matrices
-
 * Re-design the interface of low level systems
   considering the following
   - We want support for multiple symmetry directions

doc/source/whatsnew/1.0.rst

@@ -161,7 +161,7 @@ lead parameters.
 
 Change of the modes and lead_info format
 ----------------------------------------
-The `~kwant.physics.modes` now returns two objects:
+The function `~kwant.physics.modes` now returns two objects:
 `~kwant.physics.PropagatingModes` and `~kwant.physics.StabilizedModes`.  The
 first one contains the wave functions of all the propagating modes in real
 space, as well as their velocities and momenta.  All these quantities were
@@ -172,7 +172,6 @@ the `lead_info` attribute of `~kwant.solvers.default.BlockResult` contains the
 real space information about the modes in the leads (a list of
 `~kwant.physics.PropagatingModes` objects).
 
-
 Inclusion of contributed modules
 --------------------------------
 kwant now contains a sub-package :mod:`kwant.contrib` that contains various
@@ -184,4 +183,3 @@ The plotting functionality has been extended. By default, symbols and lines in
 plots are now relative to the system coordinates, i.e. will scale accordingly
 if different zoom-levels are used. Different styles for representing sites and
 hoppings are now possible. 3D plotting has been made more efficient.
-

kwant/physics/leads.py

@@ -44,11 +44,11 @@ class PropagatingModes(object):
     modes with negative velocity are ordered from larger to lower momenta, the
     modes with positive velocity vice versa.
 
-    The first dimension of the `wave_functions` corresponds to sites in a unit
-    cell, the second one to the number of the mode.  Each mode is normalized to
-    carry unit current. If several modes have the same momentum and velocity,
-    an arbitrary orthonormal basis in the subspace of these modes is
-    chosen.
+    The first dimension of `wave_functions` corresponds to the orbitals of all
+    the sites in a unit cell, the second one to the number of the mode.  Each
+    mode is normalized to carry unit current. If several modes have the same
+    momentum and velocity, an arbitrary orthonormal basis in the subspace of
+    these modes is chosen.
     """
     def __init__(self, wave_functions, velocities, momenta):
         kwargs = locals()
@@ -118,7 +118,7 @@ def setup_linsys(h_cell, h_hop, tol=1e6, stabilization=None):
         Numbers are considered zero when they are smaller than `tol` times
         the machine precision.
     stabilization : list of 2 booleans or None
-        Which steps of the eigenvalue prolem stabilization to perform. If the
+        Which steps of the eigenvalue problem stabilization to perform. If the
         value is `None`, then kwant chooses the fastest (and least stable)
         algorithm that is expected to be sufficient.  For any other value,
         kwant forms the eigenvalue problem in the basis of the hopping singular

kwant/solvers/common.py

@@ -79,7 +79,7 @@ class SparseSolver(object):
         factorized : object
             The result of calling `_factorized` for the matrix a.
         b : sparse matrix
-            The right hand side. Its format much match `rhsformat`.
+            The right hand side. Its format must match `rhsformat`.
         kept_vars : slice object or sequence of integers
             A sequence of numbers of variables to keep in the solution