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

Fix Schedule Limits Error Message #9278

Merged
merged 1 commit into from
Feb 22, 2022
Merged

Conversation

mitchute
Copy link
Collaborator

Pull request overview

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@mitchute mitchute added the Defect Includes code to repair a defect in EnergyPlus label Feb 18, 2022
@mitchute mitchute added this to the EnergyPlus 22.1 milestone Feb 18, 2022
@mitchute mitchute self-assigned this Feb 18, 2022
@mitchute
Copy link
Collaborator Author

The reason for the failure is due to a mismatch in the number of arguments ({}) in the format string. The format string expected 6 values, but 7 were passed, so format just failed and throws a fatal error which is caught here:

} catch (const EnergyPlus::FatalError &e) {

This seems to bring up a larger issue - we have no way of catching when we have not correctly aligned the format arguments and the values passed. It seems that E+ will just catch the error as shown, but not fail as it should. We probably need a custom check script to expose these issues.

@mitchute
Copy link
Collaborator Author

mitchute commented Feb 22, 2022

Ready for review.

I've got a draft script for doing some validation on these format strings, and I've found a few other issues. The script isn't ready for prime time just yet but I'll have it polished up and the issues fixed before the release date.

Copy link
Member

@Myoldmopar Myoldmopar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to take this. I know your script will be a big help with the robustness of the format strings, but it doesn't have to be attached to this PR.

@@ -639,7 +639,7 @@ namespace ScheduleManager {
ShowContinueError(state, " Other warning/severes about schedule values may appear.");
} else {
ShowSevereError(state,
format("{}=\"{}\", {} [{:.0R}] > {} [{:.0R}].",
format("{}{}=\"{}\", {} [{:.0R}] > {} [{:.0R}].",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clearly the correct fix to get the right number of placeholders as arguments.

@Myoldmopar
Copy link
Member

Thanks @mitchute , merging this one.

@Myoldmopar Myoldmopar merged commit 4ec1002 into develop Feb 22, 2022
@Myoldmopar Myoldmopar deleted the fix-schedule-limits-message branch February 22, 2022 20:38
@mitchute mitchute mentioned this pull request May 16, 2022
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defect Includes code to repair a defect in EnergyPlus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ScheduleTypeLimits Causing Fatal w/o Messages When Lower/Upper Values Reversed
6 participants