Fix #10718 - DXCoils StandardRatings OutputReportPredefined::addFootNoteSubTable produces invalid XML

[jmarrec]

Pull request overview

• Fixes CoilCoolingDX.cc OutputReportPredefined::addFootNoteSubTable produces invalid XML #10718

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

[jmarrec]

K, failed test: https://github.com/NREL/EnergyPlus/actions/runs/12375114058/job/34539163983?pr=10860#step:15:5820

[nrel-bot-2c]

@jmarrec it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@jmarrec it has been 8 days since this pull request was last updated.

[Myoldmopar]

This is an interesting set of changes. Ultimately I guess you are just collecting a few repeated strings into one location (great!!) and then doing some work to make sure it is valid output. You went above and beyond to bring the pytest work to the core CMakeLists scope and built some great tests to exercise your changes. I'm very happy with this. Any thoughts @JasonGlazer ?

[Myoldmopar]

I'm pushing a fix to the license year for the 2 new python files, but this appears ready anytime unless anyone has comments or objections.

[JasonGlazer]

The footnotes now have HTML in them. I wonder if they work with plain text tables and CSV tables? (or did they never work for those?)

[jmarrec]

The footnotes now have HTML in them. I wonder if they work with plain text tables and CSV tables? (or did they never work for those?)

@JasonGlazer

Take DXCoilSystemAuto.idf, modify the OutputControl:Table:Style

diff --git a/testfiles/DXCoilSystemAuto.idf b/testfiles/DXCoilSystemAuto.idf
index 398ea60ae8..94b4da3978 100644
--- a/testfiles/DXCoilSystemAuto.idf
+++ b/testfiles/DXCoilSystemAuto.idf
@@ -1859,7 +1859,7 @@
   Output:Constructions,Constructions;
 
   OutputControl:Table:Style,
-    HTML;                    !- Column Separator
+    All;                     !- Column Separator
 
   Output:Table:SummaryReports,
     AllSummary;              !- Report 1 Name

and here it is, with develop