update help of func; add another test

Author: aelligp

src/Paraview_collection.jl

@@ -4,7 +4,7 @@ using WriteVTK, Printf
 export make_paraview_collection
 
 """
-    make_paraview_collection(; dir=pwd(), pvd_name=nothing, files=nothing, file_extension = ".vtk", time = nothing)
+    make_paraview_collection(; dir=pwd(), pvd_name=nothing, files=nothing, file_extension = ".vts", time = nothing)
 
 In case one has a list of `*.vtk` files, this routine creates a `*.pvd` file that can be opened in Paraview.
 This is useful if you previously saved vtk files but didnt save it as a collection in the code itself.
@@ -13,9 +13,9 @@ Optional options
 ===
 - `dir`:    directory where the `*.vtk` are stored.
 - `pvd_name`:  filename of the resulting `*.pvd` file without extension; if not specified, `full_simulation` is used.
-- `files`:  filenames of the `*.vtk` files without extension; if not specified, all `*.vtk` files in the directory are used.
-- `file_extension`:  file extension of the vtk files. Default is `.vts` but all `vt*` should work.
-- `time`:  time of the timesteps; if not specified, pseudo time steps are assigned.
+- `files`:  Vector of the `*.vtk` files without extension; if not specified, all `*.vtk` files in the directory are used.
+- `file_extension`:  file extension of the vtk files. Default is `.vts` but all `vt*` work.
+- `time`:  Vector of the timesteps; if not specified, pseudo time steps are assigned.
 """
 function make_paraview_collection(; dir=pwd(), pvd_name=nothing, files=nothing, file_extension = ".vts", time = nothing)
 

test/test_paraview_collection.jl

@@ -37,6 +37,10 @@ make_paraview_collection("test2", files, time)
 @test isfile("test2.pvd")
 @test filesize("test2.pvd") == 317
 
+make_paraview_collection(; pvd_name="test3", files=files, time=time)
+@test isfile("test3.pvd")
+@test filesize("test3.pvd") == 317
+
 rm("test.pvd")
 rm("full_simulation.pvd")
 rm("test_files/test_depth3D.vts")