You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a new user of the package, I was surprised by the REPL show method results for many objects in this package. Upon loading creating a VTKData object, the displayed string in the REPL read "VTKData()", making me think that I had incorrectly loaded my file and the object was empty. Only upon running the dump function on the object did I then see that I had, in fact, loaded the file correctly.
In this package, VTKFile objects have an informative show method:
Informative show methods help new users understand the functionality of the package, and help debugging.
Suggested changes
I suggest that the show methods for the above listed objects should show short, informative summaries. I think it's open to discussion exactly what information should be shown.
The text was updated successfully, but these errors were encountered:
As a new user of the package, I was surprised by the REPL
show
method results for many objects in this package. Upon loading creating aVTKData
object, the displayed string in the REPL read "VTKData()
", making me think that I had incorrectly loaded my file and the object was empty. Only upon running thedump
function on the object did I then see that I had, in fact, loaded the file correctly.In this package,
VTKFile
objects have an informativeshow
method:ReadVTK.jl/src/ReadVTK.jl
Lines 169 to 180 in 09aea36
Slightly similarly,
VTKDataArray
objects have ashow
method that is slightly helpful:ReadVTK.jl/src/ReadVTK.jl
Lines 657 to 659 in 09aea36
On the other hand, the following objects have REPL
show
methods that I believe to be too terse:PVTKFile
objectsReadVTK.jl/src/ReadVTK.jl
Lines 278 to 280 in 09aea36
PVDFile
objects:ReadVTK.jl/src/ReadVTK.jl
Lines 346 to 348 in 09aea36
VTKData
objects:ReadVTK.jl/src/ReadVTK.jl
Line 372 in 09aea36
PVTKData
objects:ReadVTK.jl/src/ReadVTK.jl
Line 388 in 09aea36
PVTKDataArray
objects:ReadVTK.jl/src/ReadVTK.jl
Line 573 in 09aea36
Reason changes should be made
Informative
show
methods help new users understand the functionality of the package, and help debugging.Suggested changes
I suggest that the
show
methods for the above listed objects should show short, informative summaries. I think it's open to discussion exactly what information should be shown.The text was updated successfully, but these errors were encountered: