Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the connection between xml VTK file extensions and VTKFile tag type #20

Open
2 tasks
elrnv opened this issue Dec 27, 2021 · 0 comments
Open
2 tasks
Labels
good first issue Good for newcomers

Comments

@elrnv
Copy link
Owner

elrnv commented Dec 27, 2021

The XML based VTK files use extensions (e.g. .vtu, .vtp, .vts), which indicate the type of object being represented. This must match the type specified in the VTKFile xml tag (e.g. UnstructuredGrid, PolygonData, StructuredGrid resp.). We should clarify this connection somewhere in the docs, and improve the error message that currently reads:

XML error: The extension of the VTK file doesn't match the type specified in the VTKFile tag

to specify potential resolutions (recommend file extension to match the VTKFile tag or a VTKFile tag to match the extension).

Action items:

  • Include a section in related doc comments (as well as a reference to this section in the export functions) to clarify the necessity for the extension to match the type in the XML file.
  • Update the related error message with more helpful suggestions in how to resolve the issue.
@elrnv elrnv added the good first issue Good for newcomers label Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant