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.

Sign up for GitHub

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

Jump to bottom

Fix typos in outputs/docs/src/etc. #10760

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from
Open

Fix typos in outputs/docs/src/etc. #10760

wants to merge 11 commits into from

Conversation

shorowit
Copy link
Contributor

@shorowit shorowit commented Sep 23, 2024 •
edited
Loading

Pull request overview

  • Fixes various typos in docs, src/test, IDD.
  • IDD changes are all in notes, so not a breaking change.
  • A couple src changes (that I point out below) change outputs

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

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

@shorowit shorowit added the DoNotPublish Includes changes that shouldn't be reported in the changelog label Sep 23, 2024
@shorowit shorowit changed the title Typos galore Fix typos in docs/src/etc. Sep 23, 2024
shorowit
shorowit commented Sep 23, 2024
View reviewed changes
src/EnergyPlus/ChillerAbsorption.cc
"Iniital Design Size Design Generator Fluid Flow Rate [m3/s]",
"Initial Design Size Design Generator Fluid Flow Rate [m3/s]",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Seems like this affects output?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah probably worth mentioning at least. I can try to collect the changes here that "affect" output and add it to the new 25.1 output changes file.

src/EnergyPlus/DXCoils.cc
state.dataOutRptPredefined->pdchVAVDXFanName = newPreDefColumn(state, state.dataOutRptPredefined->pdstVAVDXCoolCoil, "Assocated Fan");
state.dataOutRptPredefined->pdchVAVDXFanName = newPreDefColumn(state, state.dataOutRptPredefined->pdstVAVDXCoolCoil, "Associated Fan");
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Affects output?

src/EnergyPlus/HeatRecovery.cc
: (this->type == HVAC::HXType::Desiccant_Balanced ? "Dessicant Balanced" : "Generic"));
: (this->type == HVAC::HXType::Desiccant_Balanced ? "Desiccant Balanced" : "Generic"));
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Affects output?

src/EnergyPlus/HybridUnitaryAirConditioners.cc
"Zone Hybrid Unitary HVAC DehumidificationLoad to Humidistat Setpoint Heat Tansfer Energy",
"Zone Hybrid Unitary HVAC Dehumidification Load to Humidistat Setpoint Heat Transfer Energy",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Affects output?

src/EnergyPlus/HybridUnitaryAirConditioners.cc
"Zone Hybrid Unitary HVAC Humidification Load to Humidistat Setpoint Heat Tansfer Energy",
"Zone Hybrid Unitary HVAC Humidification Load to Humidistat Setpoint Heat Transfer Energy",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Affects output?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A bunch of these HybridUnitaryAC outputs don't appear in the documentation.

src/EnergyPlus/SteamBaseboardRadiator.cc
"User-Speicified Maximum Steam Flow Rate [m3/s]",
"User-Specified Maximum Steam Flow Rate [m3/s]",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Affects output?

src/EnergyPlus/SurfaceGeometry.cc
"Visible Reflectance,Surface Glazing Fraction,Surface Glazing Contruction\n");
"Visible Reflectance,Surface Glazing Fraction,Surface Glazing Construction\n");
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Affects output?

@shorowit shorowit added the Defect Includes code to repair a defect in EnergyPlus label Sep 23, 2024
@github-actions GitHub Actions
Copy link

⚠️ Regressions detected on macos-14 for commit dbaffa3

Regression Summary
  • Table Big Diffs: 23
  • Table String Diffs: 26
  • EIO: 8
  • ERR: 7
  • RDD: 1

@github-actions GitHub Actions
Copy link

⚠️ Regressions detected on macos-14 for commit e3dcda8

Regression Summary
  • Table Big Diffs: 23
  • Table String Diffs: 26
  • EIO: 8
  • ERR: 7
  • RDD: 1

@shorowit shorowit added the OutputChange Code changes output in such a way that it cannot be merged after IO freeze label Sep 23, 2024
@shorowit shorowit marked this pull request as ready for review September 23, 2024 19:43
@shorowit
Copy link
Contributor Author

shorowit commented Sep 23, 2024 •
edited
Loading

I looked through a bunch of the regression files and they are all typo fixes to column names, etc. This should be good to go, other than needing to mention all these output changes in OutputChanges.md (which I could use some help with).

@shorowit shorowit changed the title Fix typos in docs/src/etc. Fix typos in outputs/docs/src/etc. Oct 10, 2024
@github-actions GitHub Actions
Copy link

⚠️ Regressions detected on macos-14 for commit 752e591

Regression Summary
  • Table Big Diffs: 23
  • Table String Diffs: 26
  • EIO: 8
  • ERR: 7
  • RDD: 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Myoldmopar Myoldmopar Awaiting requested review from Myoldmopar

@mjwitte mjwitte Awaiting requested review from mjwitte

Assignees
No one assigned
Labels
Defect Includes code to repair a defect in EnergyPlus DoNotPublish Includes changes that shouldn't be reported in the changelog OutputChange Code changes output in such a way that it cannot be merged after IO freeze
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shorowit @Myoldmopar