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.

Sign up for GitHub

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

Jump to bottom

Improve discoverability with expect! as alias for unwrap! #872

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve discoverability with expect! as alias for unwrap! #872

wants to merge 2 commits into from

Commits on Oct 9, 2024

  1. Improve discoverability with expect! as alias for unwrap! 

    See related issue: knurling-rs#867
Its easy to assume unwrap! can not have a message like std's expect.

Adding an expect macro will help both autocomplete guide programmers
looking for one and those who discount the unwrap entry in the defmt
api docs based on their knowledge that std's unwrap can not have a
message.

The documentation of the expect alias highlights that unwrap works with
a message to and points to the unwrap macro docs for details.
    @dvdsk
    dvdsk committed Oct 9, 2024
    Configuration menu
    Copy the full SHA
    1e1f284 View commit details
    Browse the repository at this point in the history

  2. changelog entry

    @dvdsk
    dvdsk committed Oct 9, 2024
    Configuration menu
    Copy the full SHA
    e6f82f4 View commit details
    Browse the repository at this point in the history