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

Unintuitive behaviour for uwuw_preproc with flag -o #716

Open
helen-brooks opened this issue Dec 10, 2020 · 0 comments
Open

Unintuitive behaviour for uwuw_preproc with flag -o #716

helen-brooks opened this issue Dec 10, 2020 · 0 comments

Comments

@helen-brooks
Copy link
Collaborator

Currently, the help message flag for uwuw_preproc describes the behaviour for the flag -o as:
-o [--output] : Specify the output filename (default )
I would normally expect an output file specified by command line to be a new file created by the running the executable. While a new file will be created if one is not already present, it will not contain the mesh geometry, only the metadata. The actual intended usage of the flag, which was not immediately clear, is that the output file already exists and contains the same geometry as the input file provided, and the program is simply appending the metadata. In this sense, in my mind this is just another input file (it just happens to be modified).

I would suggest that
i) The help message is improved to reflect the intended usage.
ii) If the output file is being created, the mesh data is then added, or alternatively the program exits with a failure and/or appropriate warning message that the file doesn't exist.
iii) If the program detects that a file does already exist and is just being appended, there should be a warning to the user that it their prerogative to ensure that the geometry is the same. (I could easily envisage a scenario where the wrong file was appended).
iv) Optionally split cases (ii) and (iii) into having separate flags; perhaps -c for create and -a for append, and remove -o entirely due to its ambiguity?
v) Presumably tests should be added for the append/create cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant