minor documentation update

rpoleski · Sep 14, 2017 · de8d64b · de8d64b
1 parent 52fcb17
commit de8d64b
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/source/MulensModel/caustics.py b/source/MulensModel/caustics.py
@@ -10,9 +10,9 @@ class Caustics(object):
     i.e. mass ratio and separation. Implemented for 2-body lenses only.
 
     Attributes:
-        q : float
+        q : *float*
             mass ratio between the 2 bodies
-        s : float
+        s : *float*
             separation between the 2 bodies (as a fraction of the
             Einstein ring)
     """
@@ -43,7 +43,7 @@ class CriticalCurve(object):
         left (q < 1).
 
         Attributes:
-            x, y : list
+            x, y : *list*
                 Two lists of length *n_points* giving the x, y
                 coordinates of the caustic points. 
         
@@ -58,7 +58,7 @@ def plot(self, n_points=5000, **kwargs):
         Plots the caustics (using matplotlib.pyplot.scatter()). 
 
         Parameters:
-            n_points : int, optional
+            n_points : *int*, optional
                 The number of points to calculate along the caustic.
             **kwargs :
                 keywords accepted by matplotlib.pyplot.scatter()
@@ -74,11 +74,11 @@ def get_caustics(self, n_points=5000):
         left (for q < 1).
 
         Parameters:
-            n_points : int, optional
+            n_points : *int*, optional
                 The number of points to calculate along the caustic.
 
         Returns:
-            x, y : list
+            x, y : *list*
                 Two lists of length *n_points* giving the x, y
                 coordinates of the caustic points. 
         """

diff --git a/source/MulensModel/mulensobjects/lens.py b/source/MulensModel/mulensobjects/lens.py
@@ -221,7 +221,7 @@ def mass_1(self):
         *astropy.Quantity*
 
         The mass of the primary. Defined as total_mass *
-        epsilon[0]. An astropy.Quantity with mass units. If set as a
+        epsilon[0]. An *astropy.Quantity* with mass units. If set as a
         *float*, units are assumed to be solMass.
         """
         return self.total_mass * self._epsilon[0]
@@ -239,7 +239,7 @@ def mass_2(self):
         *astropy.Quantity*
 
         The mass of the secondary. Defined as total_mass *
-        epsilon[1]. An astropy.Quantity with mass units. If set as a
+        epsilon[1]. An *astropy.Quantity* with mass units. If set as a
         *float*, units are assumed to be solMass.
 
         Note that if total_mass is defined before mass_2, and there is
@@ -261,7 +261,7 @@ def mass_3(self):
         *astropy.Quantity*
 
         The mass of the tertiary. Defined as total_mass * epsilon[2]. 
-        An astropy.Quantity with mass units. If set as a
+        An *astropy.Quantity* with mass units. If set as a
         *float*, units are assumed to be solMass.
 
         Note that if total_mass is defined before mass_3, and there is
@@ -382,7 +382,7 @@ def a_proj(self):
         *astropy.Quantity*
 
         Projected separation between the components of the lens in
-        AU. An astropy.Quantity with distance units. If set as float
+        AU. An *astropy.Quantity* with distance units. If set as *float*
         (without units), AU is assumed.
         """
         raise NotImplementedError('a_proj is not used, e.g. to set s')

diff --git a/source/MulensModel/mulensobjects/mulenssystem.py b/source/MulensModel/mulensobjects/mulenssystem.py
@@ -77,7 +77,7 @@ def mu_rel(self):
         *astropy.Quantity*
 
         Relative proper motion between the source and lens
-        stars. If set as a float, units are assumed to be mas/yr.
+        stars. If set as a *float*, units are assumed to be mas/yr.
         """
         return self._mu_rel
 
@@ -159,7 +159,7 @@ def plot_magnification(self, u_0=None, alpha=None,**kwargs):
         be specified.
 
         Parameters : 
-            u_0 : float
+            u_0 : *float*
                 Impact parameter between the source and the lens (as a
                 fraction of the Einstein ring)