From ecda7f244464a7b60aa9cf581a6dc1e1bd0a1980 Mon Sep 17 00:00:00 2001 From: Tom Milligan Date: Fri, 11 Mar 2022 08:34:57 +0000 Subject: [PATCH] chore: prepare for v1.2.0 release --- CHANGELOG.md | 6 ++++++ README.md | 9 ++++++++- pretty_assertions/Cargo.toml | 2 +- 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7432083..b7004e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Unreleased +# v1.2.0 + +## Changed + +- `assert_eq` compares `str`-like values without `Debug` formatting. ([#92](https://github.com/colin-kiegel/rust-pretty-assertions/pull/92), [@dtolnay](https://github.com/dtolnay)) + # v1.1.0 ## Added diff --git a/README.md b/README.md index 53ab051..5cf77cc 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,13 @@ fn main() { +## Semantic Versioning + +The exact output of assertions is **not guaranteed** to be consistent over time, and may change between minor versions. +The output of this crate is designed to be read by a human. It is not suitable for exact comparison, for example in snapshot testing. + +This crate adheres to semantic versioning for publically exported crate items, **except** the `private` module, which may change between any version. + ## Tip Specify it as [`[dev-dependencies]`](http://doc.crates.io/specifying-dependencies.html#development-dependencies) @@ -65,7 +72,7 @@ Also add `#[cfg(test)]` to your `use` statements, like this: use pretty_assertions::{assert_eq, assert_ne}; ``` -## Note +## Notes - Since `Rust 2018` edition, you need to declare `use pretty_assertions::{assert_eq, assert_ne};` per module. diff --git a/pretty_assertions/Cargo.toml b/pretty_assertions/Cargo.toml index 536cfea..094640e 100644 --- a/pretty_assertions/Cargo.toml +++ b/pretty_assertions/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "pretty_assertions" -version = "1.1.0" +version = "1.2.0" authors = [ "Colin Kiegel ", "Florent Fayolle ",