From 23ed797ad94060cc0451d091c3c6d4d466d32903 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 30 May 2017 18:02:11 -0400 Subject: [PATCH] Some docs for the FieldPlotter --- sumpy/visualization.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/sumpy/visualization.py b/sumpy/visualization.py index 1bc9cbe3..7c8737bf 100644 --- a/sumpy/visualization.py +++ b/sumpy/visualization.py @@ -23,6 +23,10 @@ THE SOFTWARE. """ +___doc___ = """ +.. autoclass:: FieldPlotter +""" + import numpy as np from six.moves import range @@ -59,6 +63,12 @@ def separate_by_real_and_imag(data, real_only): class FieldPlotter: + """ + .. automethod:: set_matplotlib_limits + .. automethod:: show_scalar_in_matplotlib + .. automethod:: show_scalar_in_mayavi + .. automethod:: write_vtk_file + """ def __init__(self, center, extent=1, npoints=1000): center = np.asarray(center) self.dimensions, = dim, = center.shape -- GitLab