From 4f0f57c29e1d429eccfadd4c688b69be168962fd Mon Sep 17 00:00:00 2001 From: "Alinson S. Xavier" Date: Fri, 28 May 2021 11:05:31 -0500 Subject: [PATCH] Update CHANGELOG.md --- CHANGELOG.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f42feb..c44ae12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,22 +1,29 @@ # Changelog All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +- The format is based on [Keep a Changelog][changelog]. +- This project adheres to [Semantic Versioning][semver]. +- For versions before 1.0, we follow [the Pkg.jl convention][pkjjl] + that `0.a.b` is compatible with `0.a.c`. + +[changelog]: https://keepachangelog.com/en/1.0.0/ +[semver]: https://semver.org/spec/v2.0.0.html +[pkjjl]: https://pkgdocs.julialang.org/v1/compatibility/#compat-pre-1.0 ## [0.2.0] - 2021-05-28 ### Added -- Add sub-hourly unit commitment -- Add `UnitCommitment.write(filename, solution)` -- Add mathematical formulation to the documentation +- Add sub-hourly unit commitment. +- Add `UnitCommitment.write(filename, solution)`. +- Add mathematical formulation to the documentation. ### Changed -- Rename "Time (h)" parameter to "Time horizon (h)" +- Rename "Time (h)" parameter to "Time horizon (h)". - Rename `UnitCommitment.get_solution` to `UnitCommitment.solution`, for better consistency with JuMP style. - Add an underscore to the name of all functions that do not appear in the documentation (e.g. `something` becomes `_something`) These functions are not - part of the public API and may change without notice, even in patch versions. + part of the public API and may change without notice, even in PATCH releases. - The function `UnitCommitment.build_model` now returns a plain JuMP model. The struct `UnitCommitmentModel` has been completely removed. Accessing model elements can now be accomplished as follows: @@ -28,15 +35,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `model.lodf` becomes `model[:lodf]` ### Fixed -- Properly validate solutions with price-sensitive loads +- Properly validate solutions with price-sensitive loads. ## [0.1.1] - 2020-11-16 ### Added -- Add OR-LIB and Tejada19 instances -- Improve documentation +- Add OR-LIB and Tejada19 instances. +- Improve documentation. ## Fixed -- Fixes to MATLAB and PGLIB-UC instances +- Fixes to MATLAB and PGLIB-UC instances. ## [0.1.0] - 2020-11-06 -- Initial public release +- Initial public release.