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

updates to change log for v2.0.0 #231

Merged
merged 2 commits into from
Mar 7, 2018
Merged

updates to change log for v2.0.0 #231

merged 2 commits into from
Mar 7, 2018

Conversation

cahartin
Copy link
Contributor

@cahartin cahartin commented Mar 7, 2018

address #216

@cahartin cahartin requested review from bpbond and rplzzz March 7, 2018 15:57
@cahartin cahartin added this to To Do in checklist for v2.0 via automation Mar 7, 2018
@cahartin cahartin mentioned this pull request Mar 7, 2018
changelog.txt Outdated
@@ -1,3 +1,17 @@
Hector 2.0.0
============
* Incorporated 1-D diffusive ocean heat model (DOECLIM)
Copy link
Member

Choose a reason for hiding this comment

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

Be consistent with capitalization: either don't capitalize this line, or capitalize the following ones.

changelog.txt Outdated
============
* Incorporated 1-D diffusive ocean heat model (DOECLIM)
* deleted the old temperature component
* bugfix: double counting halocarbon radiative forcing
Copy link
Member

Choose a reason for hiding this comment

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

Ideally provide issue numbers for reference: "...forcing (#201 )"

changelog.txt Outdated
* bugfix: double counting halocarbon radiative forcing
* bugfix: re-enabled CO2 concentration constraint
* initalized FSO2 first before FSO2i and FSO2d
* getComponentName now public
Copy link
Member

Choose a reason for hiding this comment

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

Why? Was this to better support pyhector? Maybe clarify

Copy link
Contributor

Choose a reason for hiding this comment

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

I wouldn't bother with stuff like this in the change log, as it's not user-visible. The change log is for telling users what has changed from their perspective. What is different in the interface? How will the results be different? It isn't necessary or desirable to note implementation changes with no effects that are visible to users.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes. most of those changes after bug fix were to support pyhector

Copy link
Contributor

Choose a reason for hiding this comment

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

You could collapse all such changes into a single line something like:

  • Various changes to internals to support pyhector

Copy link
Member

Choose a reason for hiding this comment

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

Then maybe a single line saying "Variety of internal changes to better support calling Hector from external code like pyhector"

Copy link
Contributor

Choose a reason for hiding this comment

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

Ha! Beat you by 18 seconds!

@cahartin cahartin merged commit 1b66c77 into rc2.0.0 Mar 7, 2018
checklist for v2.0 automation moved this from To Do to Done Mar 7, 2018
@cahartin cahartin deleted the changelog_v2 branch March 7, 2018 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants