Skip to content
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

Write release notes #27

Closed
helmbold opened this issue Jun 14, 2016 · 1 comment
Closed

Write release notes #27

helmbold opened this issue Jun 14, 2016 · 1 comment

Comments

@helmbold
Copy link
Contributor

Each release should have a simple wiki page with release notes. This is not only useful for existing users but a good "marketing" instrument, too. The Rust team gets a lot of attention every six weeks, because they write down what's new.

@sksamuel
Copy link
Member

Good idea, I will start this on the next release.

On 14 June 2016 at 12:59, Christian Helmbold notifications@github.com
wrote:

Each release should have a simple wiki page with release notes. This is
not only useful for existing users but a good "marketing" instrument, too.
The Rust team gets a lot of attention every six weeks, because they write
down what's new.


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#27, or mute the thread
https://github.com/notifications/unsubscribe/AAtZGgfdccwB49iSguBUX3jaPBkSpS0Wks5qLpeSgaJpZM4I1PlU
.

@sksamuel sksamuel closed this as completed Jul 3, 2016
github-merge-queue bot pushed a commit that referenced this issue Feb 27, 2024
When keys are data classes with several fields, it really helps to find
similarities between actual and expected keys, as shown in the section
"Possible matches for missing keys" of the following output, where the
matcher finds the most similar key:
```
val sweetGreenApple = Fruit("apple", "green", "sweet")
val sweetGreenPear = Fruit("pear", "green", "sweet")

            val e = shouldThrow<AssertionError> {
               mapOf(
                  sweetGreenApple to 1
               ) should containExactly(mapOf(sweetGreenPear to 1))
            }
            e.message shouldBe """
            |
            |Expected:
            |  mapOf(Fruit(name=apple, color=green, taste=sweet) to 1)
            |should be equal to:
            |  mapOf(Fruit(name=pear, color=green, taste=sweet) to 1)
            |but differs by:
            |  missing keys:
            |    Fruit(name=pear, color=green, taste=sweet)
            |  extra keys:
            |    Fruit(name=apple, color=green, taste=sweet)
            |
            |Possible matches for missing keys:
            |
            | expected: Fruit(name=pear, color=green, taste=sweet),
            |  but was: Fruit(name=apple, color=green, taste=sweet),
            |  distance: 0.67,
            |  fields:
            |  name expected: "pear", but was: "apple"
            |  color = "green"
            |  taste = "sweet"
              """.trimMargin()
```

---------

Co-authored-by: Emil Kantis <emil.kantis@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants