Update changelog #321
Update changelog #321
Conversation
|
Changed my mind and added the tiny changelog for |
CHANGELOG.md
Outdated
| - Implemented `BlockRngCore` for `ChaCha` and `Hc128`. (#281) | ||
| - All PRNGs are now portable across big- and little-endian architectures. (#209) | ||
| - `Isaac64Rng::next_u32` no longer throws away half the results. (#209) | ||
| - Added `IsaacRng::new_from_u64` and `Isaac64Rng::new_from_u64`. (#209) |
There was a problem hiding this comment.
one more change to note: removed IsaacWordRng
There was a problem hiding this comment.
Was that ever visible? I don't think so
CHANGELOG.md
Outdated
| ### Crate features and organisation | ||
| - Minimum Rust version update: 1.22.0. (#239) | ||
| - Created a seperate `rand-core` crate. (#288) | ||
| - deprecated `rand_derive`. (#256) |
CHANGELOG.md
Outdated
| (changes included here because they greatly influence the Rand crate) | ||
| - `RngCore` and `SeedableRng` are now part of `rand-core`. (#288) | ||
| - Added modules to help implementing RNGs `impl` and `le`. (#209, #228) | ||
| - added `Error` and `ErrorKind`. (#225) |
CHANGELOG.md
Outdated
| - added `Error` and `ErrorKind`. (#225) | ||
| - Added `CryptoRng` marker trait. (#273) | ||
| - Added `BlockRngCore` trait. (#281) | ||
| - Added `BlockRng` wrapper to help implemtations. (#281) |
CHANGELOG.md
Outdated
| ### Other traits and types | ||
| - Added `NewRng` trait. (#233) | ||
| - Added `SmallRng` wrapper. (#296) | ||
| - Rewritten `ReseedingRng` to only work with `BlockRngCore` (much improved performance). (#281) |
There was a problem hiding this comment.
substantial performance improvement
CHANGELOG.md
Outdated
| - Added `IsaacRng::new_from_u64` and `Isaac64Rng::new_from_u64`. (#209) | ||
| - Added the HC-128 CSPRNG `Hc128Rng`. (#210) | ||
| - Added `ChaChaRng::set_rounds` method. (#243) | ||
| - Changes to `JitterRng` to get it's size down from 2112 to 24 bytes. (#251) |
CHANGELOG.md
Outdated
| - Added support for CloudABI. (#224) | ||
| - Removed support for NaCl. (#225) | ||
| - Replaced stubs with proper WASM support in `OsRng`. (#272) | ||
| - Keep open only a single file descriptor for `OsRng`, on systems that do not have a syscall interface. (#239) |
There was a problem hiding this comment.
On systems that do not have a syscall interface, only keep a single file descriptor open for OsRng. (#239)
CHANGELOG.md
Outdated
| - Reworked `Range` type, making it possible to implement it for user types. (#274) | ||
| - Added `Range::new_inclusive` for inclusive ranges. (#274) | ||
| - Added `Range::sample_single` to allow for optimized implementations. (#274) | ||
| - Uses widening multiply method for much faster integer range reduction. (#274) |
rand-core/CHANGELOG.md
Outdated
| (Split out of the Rand crate, changes here are relative to rand 0.4.2) | ||
| - `RngCore` and `SeedableRng` are now part of `rand-core`. (#288) | ||
| - Added modules to help implementing RNGs `impl` and `le`. (#209, #228) | ||
| - added `Error` and `ErrorKind`. (#225) |
|
Also note that the previous changelog entries were written in the imperative ('add', 'change', 'implement'), and not in the past tense ('added', 'changed', etcetera). |
|
Good point! I wrote both 😄. Do you have an idea what is best for a changelog? |
|
Personal preference: I like the imperative mood better. |
|
Okay, I will reword after some more review |
CHANGELOG.md
Outdated
| - PRNGs no longer implement `Copy`. (#209) | ||
| - `Debug` implementations no longer show internals. (#209) | ||
| - Implemented serialisation for `XorShiftRng`, `IsaacRng` and `Isaac64Rng` under the `serde-1` feature. (#189) | ||
| - Implemented `BlockRngCore` for `ChaCha` and `Hc128`. (#281) |
There was a problem hiding this comment.
Should be ChaChaCore and Hc128Core.
|
FYI I'm writing an "update guide" which will be a more wordy version of roughly the same stuff, with hints at what users should use. |
|
Looks good! Happy to merge? We should also add a link to the rand-core changelog and to the updating guide — maybe after both are merged. |
|
@abreis Thanks for reviewing |
Okay, that were quite some PRs to sift through 😄. Maybe we should try update the changelog with each new feature in the future...
I have left the 'Added, Removed, Changed' pattern, but tried to group the changes into somewhat logical blocks.
Personally I think it is best to have two separate things: a simple list in the changelog of all the changes, and a separate release announcement highlighting specific changes and how to work with them.
I will make a separate PR to add a small changelog for
rand-core