more docs

timothydmorton · Mar 13, 2015 · 61df56a · 61df56a
1 parent f18c534
commit 61df56a
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/isochrones/starmodel.py b/isochrones/starmodel.py
@@ -34,6 +34,13 @@
 class StarModel(object):
     """An object to represent a star, with observed properties, modeled by an Isochrone
 
+    This is used to fit a physical stellar model to observed
+    quantities, e.g. spectroscopic or photometric, based on
+    an :class:`Isochrone`.
+
+    Note that by default a local metallicity prior, based on SDSS data,
+    will be used when :func:`StarModel.fit_mcmc` is called.
+
     :param ic: 
         :class:`Isochrone` object used to model star.