Skip to content

Conversation

@kevin-moos
Copy link
Contributor

Pull request overview

Description of the purpose of this PR

Update .tex file that references old output variable name.

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

@kevin-moos kevin-moos marked this pull request as ready for review December 19, 2025 19:15
Copy link
Collaborator

@rraustad rraustad left a comment

Choose a reason for hiding this comment

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

Looks correct.

{9B16DA05-7A2C-4AF3-A11E-3419E92FE404}

@rraustad rraustad added Documentation Related primarily on the LaTeX-based EnergyPlus documentation Defect Includes code to repair a defect in EnergyPlus labels Jan 7, 2026
@rraustad
Copy link
Collaborator

rraustad commented Jan 7, 2026

@mitchute this doc change should not cause any issues with doc builds. When I click on the link I get a Bad request warning. This branch can merge as-is.

image

@mitchute
Copy link
Collaborator

mitchute commented Jan 7, 2026

@mitchute this doc change should not cause any issues with doc builds. When I click on the link I get a Bad request warning. This branch can merge as-is.

Agreed. The Windows MikTex download hosted at UIUC is flaky. @jmarrec FYI

@mitchute mitchute merged commit 4d31537 into NatLabRockies:develop Jan 7, 2026
10 of 13 checks passed
@mitchute mitchute deleted the Fix-11105-Update-documentation-for-Lights-Radiant-Heating-Energy-output-variable branch January 7, 2026 19:17
@jmarrec
Copy link
Contributor

jmarrec commented Jan 8, 2026

Miktex download is flaky, generally, if you don't specify which mirror you want.

Can't recall why we picked ctan.math.illinois.edu but I think we had good reasons (is this wishful thinking?)

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 Documentation Related primarily on the LaTeX-based EnergyPlus documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

IO Reference : "(Zone?) Lights Radiant Heat Gain" output variable?

6 participants