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

Third Set of Engineering Reference Comprehensive Edits #6967

Merged
merged 11 commits into from Sep 19, 2018

Conversation

RKStrand
Copy link
Contributor

Pull request overview

This work is the third of an anticipated six defects that look to fix a host of issues in the Engineering Reference including equation reference errors, equation inconsistencies and errors, figure and table reference issues, and a host of other mistakes, typos, formatting issues noted along the way. This third defect covers from the start of Section 11 (~p.572) through the mid-point in the document (~p.862). This work resolves GitHub Issue #6909

Work Checklist

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)
  • At least one of the following appropriate labels must be added to this PR to be consumed into the changelog:

Review Checklist

This will not be exhaustively relevant to every PR.

  • Functional code review (it has to work!)
  • If defect, results of running current develop vs this branch should exhibit the fix
  • CI status: all green or justified
  • Performance: CI Linux results include performance check
  • Unit Test(s)
  • C++ checks:
    • Argument types
    • If any virtual classes, ensure virtual destructor included, other things
  • IDD changes:
    • Verify naming conventions and styles, memos and notes and defaults
    • Open windows IDF Editor with modified IDD to check for errors
    • If transition, add to input rules file for interfaces
    • If transition, add transition source
    • If transition, update idfs
  • If new idf included, locally check the err file and other outputs
  • Required documentation updates?
  • ExpandObjects changes?
  • If output changes, including tabular output structure, add to output rules file for interfaces

Minor fixes to Chapters 11 and 12 of the Engineering Reference
More changes/edits to clean up the Engineering Reference through
roughly p. 669
Changes to the engineering reference that picked up where the last
commit ended up through the end of Boilers
Changes to Engineering Reference through the end of what is now chapter
14 (first chapter of encyclopedic reference chapters) after the old
chapter 14 which was no longer needed was removed.
More changes to the mid-point of the Eng Ref
Fixes to avoid any bad math delimiter errors during build.  Now builds
without any of these errors.
@RKStrand RKStrand added Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation EnergyPlus labels Sep 17, 2018
@RKStrand RKStrand self-assigned this Sep 17, 2018
@Myoldmopar Myoldmopar added this to the EnergyPlus 9.0 milestone Sep 19, 2018
@Myoldmopar Myoldmopar merged commit 26c7984 into develop Sep 19, 2018
@Myoldmopar Myoldmopar deleted the #6909-EngRefEquationFixPart3 branch September 19, 2018 20:01
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.

None yet

5 participants