Fix broken text and update documentation

peyote/sampler.py

@@ -262,6 +262,12 @@ def run_sampler(likelihood, priors, label='label', outdir='outdir',
         the loglikelhood.
     **sampler_kwargs:
         All kwargs are passed directly to the samplers `run` functino
+
+    Returns
+    ------
+    result, sampler
+        An object containing the results, and the sampler instance (useful
+        for creating plots etc)
     """
     implemented_samplers = get_implemented_samplers()
 

test/tests.py

@@ -54,8 +54,8 @@ class Test(unittest.TestCase):
             name='luminosity_distance', lower=dL - 10, upper=dL + 10)
 }
 
-        result = peyote.sampler.run_sampler(likelihood, priors, sampler='nestle',
-                                    verbose=False)
+        result, sampler = peyote.sampler.run_sampler(
+                likelihood, priors, sampler='nestle', verbose=False)
         self.assertAlmostEqual(np.mean(result.samples), dL,
                                delta=np.std(result.samples))