Docs: small layout change for 1D hist plot functions

OpenSMFS · Feb 8, 2015 · aa0c1c6 · aa0c1c6
1 parent ba68e6e
commit aa0c1c6
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/docs/source/plots.rst b/docs/source/plots.rst
@@ -25,26 +25,39 @@ Timetrace and ratetrace plots
 1D Histograms
 -------------
 
+Bursts: ratiometric quantities
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. autofunction:: hist_fret
 
 .. autofunction:: hist_S
 
 .. autofunction:: hist_burst_data
 
+
+Bursts: tail distributions
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. autofunction:: hist_size
 
 .. autofunction:: hist_size_all
 
 .. autofunction:: hist_width
 
+.. autofunction:: hist_brightness
+
 .. autofunction:: hist_sbr
 
+.. autofunction:: hist_burst_phrate
+
+
+Others
+~~~~~~
+
 .. autofunction:: hist_bg_single
 
 .. autofunction:: hist_bg
 
-.. autofunction:: hist_rate_in_burst
-
 .. autofunction:: hist_burst_delays
 
 .. autofunction:: hist_asymmetry

diff --git a/fretbursts/burst_plot.py b/fretbursts/burst_plot.py
@@ -686,7 +686,7 @@ def hist_width(d, i=0, bins=(0, 10, 0.025), pdf=True, yscale='log',
 def hist_brightness(d, i=0, bins=(0, 60, 1), pdf=True, yscale='log',
                     gamma=1, add_naa=False, label_prefix=None,
                     color=None, plot_style=None):
-    """Plot histogram of burst brightness, i.e. burst size / duration).
+    """Plot histogram of burst brightness, i.e. burst size / duration.
 
     Parameters:
         d (Data): Data object