Skip to content

IDF Editor use more general description in out of memory error - #11788

Merged
mitchute merged 2 commits into
developfrom
10321-idfed-out-mem-msg
Sep 10, 2026
Merged

mitchute merged 2 commits into
developfrom
10321-idfed-out-mem-msg

Conversation

@JasonGlazer

Copy link
Copy Markdown
Contributor

Pull request overview

Description of the purpose of this PR

Only changes the text of the IDF Editor message when an out-of-memory error occurs. The new text is to provide further help to the user so that they can fix the problem by modifying the energy+.idd file.

Pull Request Author

  • 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
  • If adding/removing any output files (e.g., eplustbl.*)
    • Update ..\scripts\Epl-run.bat
    • Update ..\scripts\RunEPlus.bat
    • Update ..\src\EPLaunch\ MainModule.bas, epl-ui.frm, and epl.vbp (VersionComments)
    • Update ...github\workflows\energyplus.py

Reviewer

  • 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

@JasonGlazer JasonGlazer self-assigned this Sep 9, 2026
@JasonGlazer JasonGlazer added the Defect Includes code to repair a defect in EnergyPlus label Sep 9, 2026
@JasonGlazer
JasonGlazer requested a review from bonnema September 10, 2026 17:01
@mitchute

Copy link
Copy Markdown
Collaborator

I copied the new EXE into an E+ install, opened an IDF, made an edit, and it worked 🤷 I'm not sure what else I can do to test this, so I'll fallback to your recommendation on this @JasonGlazer.

@JasonGlazer

Copy link
Copy Markdown
Contributor Author

@mitchute that is probably good enough. The out of memory error is difficult to reproduce but ultimately this change was just to the text of a error message. It is probably good to go.

@mitchute

Copy link
Copy Markdown
Collaborator

Sounds good. Thanks @JasonGlazer. Merging.

@mitchute
mitchute merged commit f7c1031 into develop Sep 10, 2026
8 checks passed
@mitchute
mitchute deleted the 10321-idfed-out-mem-msg branch September 10, 2026 19:51
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.

Expand IDF Editor out of memory message

3 participants