Fix doc string of solution_saving.jl (trixi-framework#499)

* fix doc string * missing comma * Update solution_saving.jl Fix indent --------- Co-authored-by: Erik Faulhaber <[email protected]>
svchb · Apr 23, 2024 · 9c1ebff · 9c1ebff
1 parent d52b835
commit 9c1ebff
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/callbacks/solution_saving.jl b/src/callbacks/solution_saving.jl
@@ -1,7 +1,8 @@
 @doc raw"""
     SolutionSavingCallback(; interval::Integer=0, dt=0.0, save_times=Array{Float64, 1}([]),
                            save_initial_solution=true, save_final_solution=true,
-                           output_directory="out", append_timestamp=false, max_coordinates=2^15,
+                           output_directory="out", append_timestamp=false, prefix="",
+                           verbose=false, write_meta_data=true, max_coordinates=2^15,
                            custom_quantities...)
 
 
@@ -25,9 +26,9 @@ To ignore a custom quantity for a specific system, return `nothing`.
 - `save_final_solution=true`:   Save the final solution.
 - `output_directory="out"`:     Directory to save the VTK files.
 - `append_timestamp=false`:     Append current timestamp to the output directory.
-- 'prefix':                     Prefix added to the filename.
+- 'prefix=""':                  Prefix added to the filename.
 - `custom_quantities...`:       Additional user-defined quantities.
-- `write_meta_data`:            Write meta data.
+- `write_meta_data=true`:       Write meta data.
 - `verbose=false`:              Print to standard IO when a file is written.
 - `max_coordinates=2^15`:       The coordinates of particles will be clipped if their
                                 absolute values exceed this threshold.