Skip to content
Snippets Groups Projects
Forked from kwant / kwant
749 commits behind the upstream repository.
  • Joseph Weston's avatar
    8fc151eb
    correctly document `__call__` for operators · 8fc151eb
    Joseph Weston authored
    Also improve the documentation for operators in general.
    
    special methods are not included by autodocs by default, and
    as class documentation pages are generated by autosummary,
    we cannot just explicitly include __call__. We get around this
    by using a custom autosummary template for the operator classes.
    
    For cython extension modules, the method signature for __call__
    is still not embedded properly.
    See https://github.com/cython/cython/issues/1577.
    8fc151eb
    History
    correctly document `__call__` for operators
    Joseph Weston authored
    Also improve the documentation for operators in general.
    
    special methods are not included by autodocs by default, and
    as class documentation pages are generated by autosummary,
    we cannot just explicitly include __call__. We get around this
    by using a custom autosummary template for the operator classes.
    
    For cython extension modules, the method signature for __call__
    is still not embedded properly.
    See https://github.com/cython/cython/issues/1577.
kwant.operator.rst 267 B

:mod:`kwant.operator` -- Operators and Observables

Observables