Skip to content

Commit

Permalink
Update CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iSoron authored May 28, 2021
1 parent e594a68 commit 4f0f57c
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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.

2 comments on commit 4f0f57c

@iSoron
Copy link
Member Author

@iSoron iSoron commented on 4f0f57c May 28, 2021

Choose a reason for hiding this comment

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

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/37747

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.0 -m "<description of version>" 4f0f57c29e1d429eccfadd4c688b69be168962fd
git push origin v0.2.0

Please sign in to comment.