[Yt-svn] yt-commit r1773 - in trunk/yt: extensions lagos

[mturk at wrangler.dreamhost.com]

Author: mturk
Date: Sat Jun 26 12:50:42 2010
New Revision: 1773
URL: http://yt.enzotools.org/changeset/1773

Log:
Fixing indentation and underlining errors



Modified:
   trunk/yt/extensions/StarAnalysis.py
   trunk/yt/lagos/TwoPointFunctions.py

Modified: trunk/yt/extensions/StarAnalysis.py
==============================================================================
--- trunk/yt/extensions/StarAnalysis.py	(original)
+++ trunk/yt/extensions/StarAnalysis.py	Sat Jun 26 12:50:42 2010
@@ -128,22 +128,24 @@
     
     def write_out(self, name="StarFormationRate.out"):
         r"""Write out the star analysis to a text file *name*. The columns are in
-        order:
-        1) Time (yrs)
-        2) Look-back time (yrs)
-        3) Redshift
-        4) Star formation rate in this bin per year (Msol/yr)
-        5) Star formation rate in this bin per year per Mpc**3 (Msol/yr/Mpc**3)
-        6) Stars formed in this time bin (Msol)
-        7) Cumulative stars formed up to this time bin (Msol)
+        order.
+
+        The columns in the output file are:
+           1. Time (yrs)
+           2. Look-back time (yrs)
+           3. Redshift
+           4. Star formation rate in this bin per year (Msol/yr)
+           5. Star formation rate in this bin per year per Mpc**3 (Msol/yr/Mpc**3)
+           6. Stars formed in this time bin (Msol)
+           7. Cumulative stars formed up to this time bin (Msol)
         
         Parameters
-        ---------
+        ----------
         name : String
             The name of the file to write to. Default = StarFormationRate.out.
         
         Examples
-        -------
+        --------
         >>> sfr.write_out("stars-SFR.out")
         """
         fp = open(name, "w")
@@ -226,7 +228,7 @@
             'salpeter'. Default = 'chabrier'.
         
         Examples
-        -------
+        --------
         >>> pf = load("RedshiftOutput0000")
         >>> spec = SpectrumBuilder(pf, "/home/user/bc/", model="salpeter")
         """
@@ -276,7 +278,7 @@
         avg_metal: Average metallicity of all the stars.
         
         Parameters
-        ---------
+        ----------
         data_source : AMRRegion object, optional
             The region from which stars are extracted for analysis. If this is
             not specified, the next three parameters must be supplied.
@@ -420,10 +422,11 @@
 
     
     def write_out(self, name="sum_flux.out"):
-        r"""Write out the summed flux to a file. The file has two columns:
-        1) Wavelength (Angstrom)
-        2) Flux (Luminosity per unit wavelength, L_sun Ang^-1,
-        L_sun = 3.826 * 10^33 ergs s^-1.)
+        r"""Write out the summed flux to a file. 
+
+        The output file from this function has two columns: Wavelength
+        (Angstrom) and Flux (Luminosity per unit wavelength, L_sun Ang^-1,
+        L_sun = 3.826 * 10^33 ergs s^-1.).
 
         Parameters
         ----------
@@ -431,7 +434,7 @@
             Name of file to write to. Default = "sum_flux.out"
         
         Examples
-        -------
+        --------
         >>> spec.write_out("spec.out")
         """
         fp = open(name, 'w')
@@ -448,7 +451,7 @@
         identical to the disk output.
         
         Parameters
-        ---------
+        ----------
         name : String
             Name of file to write to. Default = "sum_SED.out"
         flux_norm : Float
@@ -456,7 +459,7 @@
             Default = 5200 Ang.
         
         Examples
-        -------
+        --------
         >>> spec.write_out_SED(name = "SED.out", flux_norm = 6000.)
         """
         # find the f_nu closest to flux_norm

Modified: trunk/yt/lagos/TwoPointFunctions.py
==============================================================================
--- trunk/yt/lagos/TwoPointFunctions.py	(original)
+++ trunk/yt/lagos/TwoPointFunctions.py	Sat Jun 26 12:50:42 2010
@@ -586,7 +586,7 @@
         directory.
         
         Examples
-        -------
+        --------
         >>> tpf.write_out_means()
         """
         for fset in self._fsets:
@@ -618,7 +618,7 @@
         'function_name.txt' and saved in the current working directory.
         
         Examples
-        -------
+        --------
         >>> tpf.write_out_arrays()
         """
         if self.mine == 0:
@@ -702,6 +702,7 @@
             A pair of values giving the range for the bins.
             A pair of floats (a list), or a list of pairs for N-dim binning.
             Default = None.
+
         Examples
         --------
         >>> f1.set_pdf_params(bin_type='log', bin_range=[5e4, 5.5e13],
@@ -843,4 +844,4 @@
         for length in self.tpf.lengths:
             xi[length] = -1 + na.sum(self.length_bin_hits[length] * \
                 self.bin_edges[0][:-1]) / self.corr_norm
-        return xi
\ No newline at end of file
+        return xi