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 #10426 - IndoorLivingWall documentation - Fixup units, format equations and equation description and add hyperlinks #10530

Merged
merged 3 commits into from
May 28, 2024

Conversation

jmarrec
Copy link
Contributor

@jmarrec jmarrec commented May 28, 2024

Pull request overview

  • Fixes New Latex Warnings #10426
  • IndoorLivingWall documentation - Fixup units, format equations and equation description and add hyperlinks

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

…ations and equation description and add hyperlinks
@jmarrec jmarrec added Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation labels May 28, 2024
@jmarrec jmarrec self-assigned this May 28, 2024
@jmarrec
Copy link
Contributor Author

jmarrec commented May 28, 2024

IO ref:

image

image

Engineering reference:

formatting equations and their description:

image

image

Fixing units

image

Copy link
Contributor

@mjwitte mjwitte left a comment

Choose a reason for hiding this comment

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

@jmarrec Thanks for the cleanups. I added some minor touches. Once CI comes back, this will merge.
@LipingWang I noticed that the output variables for IndoorLivingWall are listed at the end of the input section in the I/O Reference, but there are no explanations for each output variable. It would be good to add these at some point before v24.2 release.

@mjwitte mjwitte merged commit fcc6cf2 into develop May 28, 2024
14 of 15 checks passed
@mjwitte mjwitte deleted the fixup_latex_indoor_living_wall branch May 28, 2024 21:17
@LipingWang
Copy link
Contributor

@jmarrec Thanks for the cleanups. I added some minor touches. Once CI comes back, this will merge. @LipingWang I noticed that the output variables for IndoorLivingWall are listed at the end of the input section in the I/O Reference, but there are no explanations for each output variable. It would be good to add these at some point before v24.2 release.

Will do! Thank you, Mike!

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.

New Latex Warnings
8 participants