-
Notifications
You must be signed in to change notification settings - Fork 48
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
Conversation
changelog.txt
Outdated
@@ -1,3 +1,17 @@ | |||
Hector 2.0.0 | |||
============ | |||
* Incorporated 1-D diffusive ocean heat model (DOECLIM) |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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!
address #216