doc edit

cmbant · Jun 27, 2015 · 4ae3073 · 4ae3073
1 parent bbab617
commit 4ae3073
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 7 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -58,7 +58,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'GetDist API'
+project = u'GetDist'
 copyright = u'2015, Antony Lewis'
 author = u'Antony Lewis'
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,7 +1,7 @@
-GetDist API
+GetDist
 ==================================
 
-GetDist is a package for analysing Monte Carlo samples, including correlated samples
+GetDist is a Python package for analysing Monte Carlo samples, including correlated samples
 from Markov Chain Monte Carlo (MCMC). To get started see the `home page <https://github.com/cmbant/getdist/>`_ 
 or `Plot Gallery and tutorial <https://github.com/cmbant/getdist/blob/master/docs/plot_gallery.ipynb>`_.
 
@@ -15,7 +15,7 @@ Main high-level modules:
 
 See also :doc:`analysis_settings`.
 
-Other modules:
+Other main modules:
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/source/plots.rst b/docs/source/plots.rst
@@ -8,11 +8,14 @@ getdist.plots
    :toctree: summaries
    :nosignatures:
 
+   getSinglePlotter
+   getSubplotPlotter
    GetDistPlotter
    GetDistPlotSettings
 
 .. automodule:: getdist.plots
    :members:
+   :exclude-members: makeList
 
 
 

diff --git a/getdist/plots.py b/getdist/plots.py
@@ -208,12 +208,14 @@ def getPlotter(**kwargs):
 
 def getSinglePlotter(ratio=3 / 4., width_inch=6, **kwargs):
     """
-    Wrapper functions to get plotter to make single plot of fixed width (default: one page column width)
+    Get a :class:`~.plots.GetDistPlotter` for making a single plot of fixed width 
+    
+    The default size is one page-column width.
 
     :param ratio: The ratio between height and width.
     :param width_inch:  The width of the plot in inches
     :param kwargs: arguments for :class:`GetDistPlotter`
-    :return: The :class:`~getdist.plots.GetDistPlotter` instance
+    :return: The :class:`~.plots.GetDistPlotter` instance
     """
     plotter = getPlotter(**kwargs)
     plotter.settings.setWithSubplotSize(width_inch)
@@ -225,7 +227,8 @@ def getSinglePlotter(ratio=3 / 4., width_inch=6, **kwargs):
 
 def getSubplotPlotter(subplot_size=2, width_inch=None, **kwargs):
     """
-    Wrapper functions to get plotter to make array of subplots.
+    Get a :class:`~.plots.GetDistPlotter` for making an array of subplots. 
+    
     If width_inch is None, just makes plot as big as needed for given subplot_size, otherwise fixes total width 
     and sets defaults from matplotlib's default rcParams.