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

Input files must have a file extension #51

Closed
ccarels opened this issue Sep 6, 2018 · 1 comment
Closed

Input files must have a file extension #51

ccarels opened this issue Sep 6, 2018 · 1 comment
Assignees

Comments

@ccarels
Copy link
Contributor

ccarels commented Sep 6, 2018

Description
Currently some files in the input_files/ have a .txt extension but some do not.

It would be good to have the code parse the file to look for a common extension.

My feeling is that the files currently under input files function more like macros, being different to actual input files which contain data to be processed.

Therefore, it might be worth considering renaming the input_files/ to macros/ and appending a .macro extension (or similar) instead of .txt, for the avoidance of doubt to the user.

Outcome
Uniform naming scheme for input files, clarification of their purpose to the user.
The code can parse and enforce the file extension.

Timeline
When convenient.

Interfaces
Will this feature result in a backwards-incompatible interface change: Yes. Existing input_files will need to be updated to include the appropriate file extension (as the code will no longer accept files without the correct file extension after this change).

Expected semantic version number increment category (Please indicate x.y.z): x.

Notes
Whatever the outcome of this issue, the interface for macros (currently called input files) must be documented.

@ccarels
Copy link
Contributor Author

ccarels commented Sep 6, 2018

@KAdamek @jan2nov Thoughts?

@ccarels ccarels closed this as completed Jan 3, 2019
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