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

Documentation Fixes - 2018b #7737

Merged
merged 13 commits into from
Mar 13, 2020
Merged

Documentation Fixes - 2018b #7737

merged 13 commits into from
Mar 13, 2020

Conversation

mitchute
Copy link
Collaborator

@mitchute mitchute commented Feb 4, 2020

This PR addresses documentation issues referenced in #7026.

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

@mitchute mitchute added the Defect Includes code to repair a defect in EnergyPlus label Feb 4, 2020
@mitchute mitchute added this to the EnergyPlus 9.3.0 milestone Feb 4, 2020
@mitchute mitchute self-assigned this Feb 4, 2020
@mitchute mitchute linked an issue Feb 7, 2020 that may be closed by this pull request
Documentation Issues - 2018b #7026
Closed
3 tasks
@mitchute
Copy link
Collaborator Author

mitchute commented Feb 7, 2020

@mjwitte I'm going to consider this blocked until #7448 merges. There's a comment in #7026 (the relevant issue for this PR) to update documentation related to AirTerminal:SingleDuct:Uncontrolled. I'll wait until you're done fully removing that object before cleaning that one up.

There are also a number of other issues referenced by @JasonGlazer which look to me like they may cause some reordering of the docs to match the ordering in the IDD. I'll need to discuss these with you and/or Jason or Edwin before working on those.

@JasonGlazer
Copy link
Contributor

I don't know if the docs or the IDD need to change order and names but they should be consistent.

@mitchute
Copy link
Collaborator Author

There is one minor code change here (a unit change at one location) and the rest are doc updates. Ready for review.

@nrel-bot-2
Copy link

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

Myoldmopar
Myoldmopar reviewed Mar 13, 2020
View reviewed changes
doc/input-output-reference/src/overview/group-condenser-equipment.tex
@@ -139,7 +139,7 @@ \subsubsection{Inputs}\label{inputs-007}

\paragraph{Field: Basin Heater Setpoint Temperature}\label{field-basin-heater-setpoint-temperature}

This numeric field contains the set point temperature (˚C) for the basin heater described in the previous field. The basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint temperature, as long as the tower fan is off and water is not flowing through the tower. This set point temperature must be greater than or equal to 2˚C, and the default value is 2˚C if this field is left blank.
This numeric field contains the set point temperature (°C) for the basin heater described in the previous field. The basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint temperature, as long as the tower fan is off and water is not flowing through the tower. This set point temperature must be greater than or equal to 2˚C, and the default value is 2˚C if this field is left blank.
Copy link
Member

Choose a reason for hiding this comment

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

It's kinda hard to see here, but did this also need the other degree symbols in this line to be replaced?

Copy link
Member

Choose a reason for hiding this comment

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

And if so, there is a conflict in the doc cmake rules. I'm happy to help resolve those and address this at the same time, if it needs to be done. Otherwise I can just resolve the conflicts.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll fix it up now.

@Myoldmopar
Copy link
Member

I've built locally, everything is fine there.

So there are a number of references to the blast translator and DOE translator in the auxiliary programs pdf. The removal of the tex files seems fine, but maybe we need to remove all the references? I see that you asked that on Feb 3 @mitchute. In my opinion, yeah I think so, but I don't mind if it is right now or later.

I pulled in develop and resolved the conflict. I'll push those changes up. I'm inclined to just drop this in for now and add the final blast/doe2 cleanups to a future issue.

@mjwitte if you have a strong feeling about cleaning all this up right now, we can do it, but otherwise this should just drop in.

@mjwitte
Copy link
Contributor

mjwitte commented Mar 13, 2020

Bombs away . . . drop it in.

@Myoldmopar Myoldmopar merged commit 320f13b into develop Mar 13, 2020
@Myoldmopar Myoldmopar deleted the doc_fix_2018b branch March 13, 2020 15:04
mjwitte
mjwitte reviewed Mar 13, 2020
View reviewed changes
src/EnergyPlus/PlantCondLoopOperation.cc
@@ -3369,7 +3369,7 @@ namespace PlantCondLoopOperation {
SetupEMSActuator(ActuatorName,
UniqueIDName,
ActuatorType,
"[W]",
"[fraction]",
Copy link
Contributor

Choose a reason for hiding this comment

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

@Myoldmopar @mitchute Does this really work as a fraction? The other supervisory on/off actuators here use Units which = "[on/off]".

EnergyManagementSystem:Actuator Available,CHILLED WATER LOOP,Supply Side Half Loop,On/Off Supervisory,[on/off]
EnergyManagementSystem:Actuator Available,CW DEMAND SIDE INLET PIPE,Plant Component Pipe:Adiabatic,On/Off Supervisory,[fraction]

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@mjwitte See this comment: #7026 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

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

Well, fancy that. Who knew. Carry on.

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

@mjwitte mjwitte mjwitte left review comments

@Myoldmopar Myoldmopar Myoldmopar left review comments

Assignees

@mitchute mitchute

Labels
Defect Includes code to repair a defect in EnergyPlus
Projects
None yet
Milestone
EnergyPlus 9.3.0
Development

Successfully merging this pull request may close these issues.

Documentation Issues - 2018b
9 participants
@mitchute @JasonGlazer @nrel-bot-2 @Myoldmopar @mjwitte @nrel-bot @nrel-bot-3 @nrel-bot-2b @nrel-bot-2c