Add docstring to BarnesSimulator to make it show up in reference docs

adityapb · Apr 8, 2016 · ff5f198 · ff5f198
1 parent add502f
commit ff5f198
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/pyspace/simulator.pyx b/pyspace/simulator.pyx
@@ -62,7 +62,9 @@ cdef class Simulator:
 
 
 cdef class BarnesSimulator(Simulator):
-    def __init__(self, PlanetArray pa, double G, double dt, double theta = 1.0, str sim_name = "pyspace"):
+    """Simulator using Barnes Hut algorithm"""
+    def __init__(self, PlanetArray pa, double G, double dt, double theta = 1.0,
+            str sim_name = "pyspace"):
         self.theta = theta
         Simulator.__init__(self, pa, G, dt, sim_name)