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

Add additional documentation and error statements to information.hpp #407

Closed
Andrea-Havron-NOAA opened this issue Jul 6, 2023 · 4 comments
Labels
kind: documentation Improvements or additions to documentation P2 mid-level priority
Milestone

Comments

@Andrea-Havron-NOAA
Copy link
Collaborator

From @nathanvaughan-NOAA:

For information.hpp there are a lot of places that need errors to be logged that currently just have //log error comments showing where this is needed. The indentation is also off on lines 221-291 which need one less indent. @Andrea-Havron-NOAA has done a great job explaining the logic of this file in the vignette which was really helpful for our review. It may or may not make sense to add some of this explanation directly in the code as comments to help future developers understand what is being done and why without having to refer back to the vignette or manual.

@Andrea-Havron-NOAA Andrea-Havron-NOAA added this to the MQ milestone Jul 11, 2023
@Andrea-Havron-NOAA Andrea-Havron-NOAA added the kind: documentation Improvements or additions to documentation label Jul 11, 2023
@nathanvaughan-NOAA
Copy link
Contributor

I made a new branch for these changes 407-information-logs

@ChristineStawitz-NOAA ChristineStawitz-NOAA added the P2 mid-level priority label Jul 18, 2023
@nathanvaughan-NOAA
Copy link
Contributor

@kellijohnson-NOAA I pushed up new changes with basic logs for CreateModel() can you take a look and let me know if you think anything is missing or should be changed. Everything is going to FIMS_LOG for now, I think we need to figure out a larger plan for how to separate logs for different sections/needs and then we can modify this but not sure that is in the scope of this issue.

@Andrea-Havron-NOAA
Copy link
Collaborator Author

@nathanvaughan-NOAA, issue #255 is probably a better issue to address a larger plan for separate log files.

@nathanvaughan-NOAA
Copy link
Contributor

Addressed in pull request #424

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: documentation Improvements or additions to documentation P2 mid-level priority
Projects
No open projects
Status: Done
Development

No branches or pull requests

4 participants