Skip to content

Implemented file writing module template with plenty of documentation

Afonso Mukai requested to merge issue_179 into master

Created by: SkyToGround

Closes #171 (closed) Closes #179 (closed)

In order to simplify the development of file writing modules, I have created a template for doing so. This template includes comments that should tell you all or most of the details required. I decided to add the template and unit tests for the template to the code being compiled in order to ensure that as the interface changes, the template is changed as well.

There are no doubt plenty of spelling errors in the documentation, feel free fix them if you find them. I will re-read everything that I wrote before I merge this branch.

There are also a few things that are not entirely clear to me about the interface, mostly regarding some of the exception handling. If @dominikwerder and @michele-brambilla wants to clarify or correct the documentation, that would be great .

Merge request reports