[Yt-svn] yt-commit r1469 - branches/yt-1.5/yt/extensions trunk/yt/extensions

[mturk at wrangler.dreamhost.com]

Author: mturk
Date: Fri Oct  2 13:35:44 2009
New Revision: 1469
URL: http://yt.enzotools.org/changeset/1469

Log:
Added a doc string for disk_analysis



Modified:
   branches/yt-1.5/yt/extensions/disk_analysis.py
   trunk/yt/extensions/disk_analysis.py

Modified: branches/yt-1.5/yt/extensions/disk_analysis.py
==============================================================================
--- branches/yt-1.5/yt/extensions/disk_analysis.py	(original)
+++ branches/yt-1.5/yt/extensions/disk_analysis.py	Fri Oct  2 13:35:44 2009
@@ -28,6 +28,10 @@
 class StackedDiskImage(object):
     def __init__(self, pf, center, norm_vec, thickness, width,
                  nslices = 100, buff_size=(800,800)):
+        """
+        This class implements an AMR data object that will stack up
+        oblique-slices to generate an image along an arbitrary axis.
+        """
         self.data = {}
         self.pf = pf
         self.center = na.array(center)

Modified: trunk/yt/extensions/disk_analysis.py
==============================================================================
--- trunk/yt/extensions/disk_analysis.py	(original)
+++ trunk/yt/extensions/disk_analysis.py	Fri Oct  2 13:35:44 2009
@@ -28,6 +28,10 @@
 class StackedDiskImage(object):
     def __init__(self, pf, center, norm_vec, thickness, width,
                  nslices = 100, buff_size=(800,800)):
+        """
+        This class implements an AMR data object that will stack up
+        oblique-slices to generate an image along an arbitrary axis.
+        """
         self.data = {}
         self.pf = pf
         self.center = na.array(center)