Commit 71cad3a0 authored by Joseph Weston's avatar Joseph Weston
Browse files

use raw strings in docstrings that contain backslashes

For sequences such as '\d' and '\s' that are *not* escape
sequences, this triggers a deprecation warning in recent
versions of Python.
parent f9254da9
......@@ -21,7 +21,7 @@ __all__ = ['SpectralDensity']
class SpectralDensity:
"""Calculate the spectral density of an operator.
r"""Calculate the spectral density of an operator.
This class makes use of the kernel polynomial
method (KPM), presented in [1]_, to obtain the spectral density
......
......@@ -13,7 +13,7 @@ __all__ = ['two_terminal_shotnoise']
def two_terminal_shotnoise(smatrix):
"""Compute the shot-noise in a two-terminal setup.
r"""Compute the shot-noise in a two-terminal setup.
In a two terminal system the shot noise is given by `tr((1 - t*t^\dagger) *
t*t^\dagger)`.
......
......@@ -555,7 +555,7 @@ class SparseSolver(metaclass=abc.ABCMeta):
def wave_function(self, sys, energy=0, args=(), check_hermiticity=True,
*, params=None):
"""
r"""
Return a callable object for the computation of the wave function
inside the scattering region.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment