Mention shorter aliases of names in docstrings
Some common names, like kwant.lattice.TranslationalSymmetry
are also provided in the top-level kwant
namespace. Individual docstrings should mention the existence of an abbreviation. For example, the second line (the one after the synopsis) of the docstring could read:
An alias exists for this common name: kwant.TranslationalSymmetry