Skip to content
Snippets Groups Projects
Commit be750290 authored by Christoph Groth's avatar Christoph Groth
Browse files

clarify the docs for the top-level kwant namespace

parent 7669a3f9
Branches
Tags
No related merge requests found
......@@ -3,9 +3,9 @@
.. module:: kwant
Along with the various modules documented in this reference, the top-level
kwant package provides short names for a few widely used objects from
several modules.
The top-level kwant package serves as a container for sub-packages and does not
have any functions of its own. For convenience, short names are provided for a
few widely used objects from the sub-packages:
.. currentmodule:: kwant.builder
......
:mod:`kwant.system` -- Low-level interface of tight binding systems
*******************************************************************
:mod:`kwant.system` -- Low-level interface of systems
*****************************************************
.. currentmodule:: kwant.system
......
"""Low-level interface of tight binding systems"""
"""Low-level interface of systems"""
from __future__ import division
__all__ = ['System', 'FiniteSystem', 'InfiniteSystem']
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment