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

Add \reference ProgramNames to PythonPlugin:Instance #8821

Merged
merged 1 commit into from
Jun 18, 2021

Conversation

jmarrec
Copy link
Contributor

@jmarrec jmarrec commented Jun 14, 2021

Pull request overview

Add \reference ProgramNames to PythonPlugin:Instance

cf NREL/OpenStudio#4353 (comment) where it was first reported. I've made the change to OpenStudio's ProposedEnergy+.idd which does enforce it, but I'm propagating upstream here for coherence.

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 jmarrec added Defect Includes code to repair a defect in EnergyPlus IDDChange Code changes impact the IDD file (cannot be merged after IO freeze) labels Jun 14, 2021
@jmarrec jmarrec requested a review from bonnema June 14, 2021 10:27
@jmarrec jmarrec self-assigned this Jun 14, 2021
@@ -103363,6 +103363,7 @@ PythonPlugin:Instance,
A1, \field Name
\required-field
\type alpha
\reference ProgramNames
Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's it.

@mitchute
Copy link
Collaborator

Sorry, I got my wires crossed on this. Deleting my previous comments.

This is good to go.

@mitchute mitchute merged commit c18d89d into develop Jun 18, 2021
@mitchute mitchute deleted the PythonPlugin_reference branch June 18, 2021 17:17
Copy link
Contributor

@bonnema bonnema left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thank you!

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 IDDChange Code changes impact the IDD file (cannot be merged after IO freeze)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants