[Yt-svn] yt-commit r1757 - trunk/yt/raven
mturk at wrangler.dreamhost.com
mturk at wrangler.dreamhost.com
Thu Jun 24 11:36:41 PDT 2010
Author: mturk
Date: Thu Jun 24 11:36:41 2010
New Revision: 1757
URL: http://yt.enzotools.org/changeset/1757
Log:
Updating docstrings to compile
Modified:
trunk/yt/raven/plot_collection.py
Modified: trunk/yt/raven/plot_collection.py
==============================================================================
--- trunk/yt/raven/plot_collection.py (original)
+++ trunk/yt/raven/plot_collection.py Thu Jun 24 11:36:41 2010
@@ -787,6 +787,7 @@
yt.lagos.BinnedProfile1D : This is the object that does the
transformation of raw data into a 1D
profile.
+
Examples
--------
@@ -977,7 +978,7 @@
Returns
-------
- plot : `yt.raven.PhasePlot`
+ plot : `yt.raven.PlotTypes.PhasePlot`
The plot that has been added to the PlotCollection.
See Also
@@ -985,15 +986,16 @@
yt.lagos.BinnedProfile2D : This is the object that does the
transformation of raw data into a 1D
profile.
+
Examples
--------
-
This will show the mass-distribution in the Density-Temperature plane.
-
+
+ >>> pf = load("RD0005-mine/RedshiftOutput0005")
>>> reg = pf.h.region([0.1, 0.2, 0.3], [0.0, 0.1, 0.2],
- [0.2, 0.3, 0.4])
+ ... [0.2, 0.3, 0.4])
>>> pc.add_phase_object(reg, ["Density", "Temperature", "CellMassMsun"],
- weight = None)
+ ... weight = None)
"""
if x_bounds is None:
x_min, x_max = data_source.quantities["Extrema"](
@@ -1108,6 +1110,7 @@
yt.lagos.BinnedProfile2D : This is the object that does the
transformation of raw data into a 1D
profile.
+
Examples
--------
More information about the yt-svn
mailing list