Granular.jl

commit ca5f203155874f7a54d8d8310805e86c9cb8bc33
parent 1d309104fabb6e82eeb413f8e04d5d2551ba89d0
Author: Anders Damsgaard <andersd@riseup.net>
Date:   Fri,  9 Jun 2017 15:08:20 -0400

improve docstrings for read/write functions

Diffstat:
M
src/io.jl
 | 
8
+++++++-

1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/src/io.jl b/src/io.jl
@@ -10,7 +10,7 @@ import JLD
                          folder::String=".",
                          verbose::Bool=true)
 
-Write all content from `Simulation` to disk in HDF5 format.  If the `filename` 
+Write all content from `Simulation` to disk in JDL format.  If the `filename` 
 parameter is not specified, it will be saved to a subdirectory under the current 
 directory named after the simulation identifier `simulation.id`.
 """
@@ -32,6 +32,12 @@ function writeSimulation(simulation::Simulation;
     end
 end
 
+"""
+    readSimulation(filename::String="";
+                   verbose::Bool=true)
+
+Read all content from `Simulation` from disk in JDL format.
+"""
 function readSimulation(filename::String="";
                          verbose::Bool=true)
     if verbose