Changeset 2068 for trunk/imports/G2img_MAR.py

Timestamp:

Nov 24, 2015 12:39:12 PM (8 years ago)

Author:

toby

Message:

cleanup image reader documetation

File:

• trunk/imports/G2img_MAR.py (modified) (3 diffs)

trunk/imports/G2img_MAR.py

@@ -11 +11 @@
 --------------------------------------
 
-Routine to read several MAR formats, .mar3450,.mar2300,.mar2560
-
 '''
 
@@ -21 +19 @@
 GSASIIpath.SetVersionNumber("$Revision: $")
 class MAR_ReaderClass(G2IO.ImportImage):
+    '''Routine to read several MAR formats, .mar3450,.mar2300,.mar2560
+    '''
     def __init__(self):
         super(self.__class__,self).__init__( # fancy way to self-reference
@@ -35 +35 @@
         
     def Reader(self,filename,filepointer, ParentFrame=None, **unused):
-        '''Read using Bob's routine
+        '''Read using Bob's routine :func:`GSASIIIO.GetMAR345Data`
+        (to be moved to this file, eventually)
         '''
         self.Comments,self.Data,self.Npix,self.Image = G2IO.GetMAR345Data(filename)