Commits

Shea Garrison-Kimmel committed 2cb53d2

Starting some work on doing docstrings well, but need to transfer to another computer.

Comments (0)

Files changed (1)

irate/gadgetbinary.py

     t1_group,t1_name,t2_group,t2_name,t3_group,t3_name,stargroup,starname,t5_group,t5_name,ics):
     """Reads a GADGET format file block by block (e.g. coordinate block for gas
     particles), writes the block to an IRATE formate HDF5 file, and then 
-    deletes that block from memory. inname is the name of the gadget binary 
-    file to be read, outname the name of the IRATE file to be written, 
+    deletes that block from memory. 
+
+    :param inname is the name of the gadget binary file to be read
+    :param  outname is the name of the IRATE file to be written, 
     potential, accel, entropy, and timestep are true if that property is 
     included in the gadget file, and the group and names determine where the
     various data goes."""