Skip to content

36 Improve output and verbose options#37

Merged
mknaranja merged 9 commits intomainfrom
36-improve-output
Aug 3, 2023
Merged

36 Improve output and verbose options#37
mknaranja merged 9 commits intomainfrom
36-improve-output

Conversation

@mknaranja
Copy link
Member

@mknaranja mknaranja commented Jul 17, 2023

Merge Request - GuideLine Checklist

Guideline to check code before resolve WIP and approval, respectively.
As many checkboxes as possible should be ticked.

Checks by code author:

Always to be checked:

  • There is at least one issue associated with the pull request.
  • New code adheres with the coding guidelines
  • No large data files have been added to the repository. Maximum size for files should be of the order of KB not MB. In particular avoid adding of pdf, word, or other files that cannot be change-tracked correctly by git.

If functions were changed or functionality was added:

  • Tests for new functionality has been added
  • A local test was succesful

If new functionality was added:

  • There is appropriate documentation of your work. (use doxygen style comments)

If new third party software is used:

  • Did you pay attention to its license? Please remember to add it to the wiki after successful merging.

If new mathematical methods or epidemiological terms are used:

  • Are new methods referenced? Did you provide further documentation?

[ ] The following questions are addressed in the documentation (if need be):

  • Developers (what did you do?, how can it be maintained?)

  • For users (how to use your work?)

  • For admins (how to install and configure your work?)

  • For documentation: Please write or update the Readme in the current working directory!

Checks by code reviewer(s):

  • Is the code clean of development artifacts e.g., unnecessary comments, prints, ...
  • The ticket goals for each associated issue are reached or problems are clearly addressed (i.e., a new issue was introduced).
  • There are appropriate unit tests and they pass.
  • The git history is clean and linearized for the merge request. All reviewers should squash commits and write a simple and meaningful commit message.
  • Coverage report for new code is acceptable.
  • No large data files have been added to the repository. Maximum size for files should be of the order of KB not MB. In particular avoid adding of pdf, word, or other files that cannot be change-tracked correctly by git.

Closes #36

@mknaranja mknaranja changed the title display templated and verbose for time output WIP: 36 Improve output and verbose options Jul 17, 2023
@mknaranja mknaranja marked this pull request as ready for review July 18, 2023 06:57
@mknaranja
Copy link
Member Author

mknaranja commented Jul 18, 2023

All in all, my suggestions are far from complete but I think this is a first approach that could be merged.

@Philou31 Could you have a quick look if you like my suggestion? Better ideas or modifications proposed? How about the many commented lines of output (in particular disp()). Do we remove or uncomment and integrate them?

@CodingAllan Can you have a check that I did not introduce any new error?

@mknaranja mknaranja changed the title WIP: 36 Improve output and verbose options 36 Improve output and verbose options Jul 18, 2023
@mknaranja mknaranja force-pushed the 36-improve-output branch from 658d37e to abd00c1 Compare July 18, 2023 07:05
@mknaranja mknaranja merged commit 0c3d3aa into main Aug 3, 2023
@mknaranja mknaranja deleted the 36-improve-output branch August 3, 2023 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve output and verbose levels

3 participants