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

Create text file writer to encapsulate report file handle #176

Open
michaeltryby opened this issue Apr 20, 2018 · 3 comments
Open

Create text file writer to encapsulate report file handle #176

michaeltryby opened this issue Apr 20, 2018 · 3 comments
Labels
Moderate Moderately Challenging Task

Comments

@michaeltryby
Copy link

michaeltryby commented Apr 20, 2018

The report file handle is hanging out in global memory space. Code for writing to it is sprinkled across the entire application. This is most evident when logging warnings and errors to the report file. Furthermore, the code for writing and the content to be written is munged together.

I am currently wrapping global variables in a structure, but this is only perpetuating the problem. A better solution would be to create a text file writer that separates report content and centralizes the code for writing to a file.

A logger should also be created for handling errors and warnings. Right now they get dumped to the report file, but the logger should dump anyplace it is directed. Would also be great if the state were managed behind the scenes so file pointers aren't getting passed around all over the place.

@michaeltryby michaeltryby added the Moderate Moderately Challenging Task label Apr 20, 2018
@bemcdonnell
Copy link
Member

@michaeltryby, I like the idea of a log that can be separated from the report file. In addition, we could log control actions outside in a controls.log file. Just and idea.

@dickinsonre
Copy link

I 2nd @bemcdonnell suggestion about a log file. So many users ignore the top of the rpt file. A separate log file might be easier for them to pay attention to or at least learn to pay attention to the warnings.

@bemcdonnell
Copy link
Member

@dickinsonre, wait... warnings matter? 😄

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

No branches or pull requests

3 participants