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 of OptionExt::ok_or_eyre #130

Open
LeoniePhiline opened this issue Dec 6, 2023 · 2 comments
Open

Improve discoverability of OptionExt::ok_or_eyre #130

LeoniePhiline opened this issue Dec 6, 2023 · 2 comments

Comments

@LeoniePhiline
Copy link
Contributor

LeoniePhiline commented Dec 6, 2023 •
edited

With the merge of #129, the new feature option.ok_or_eyre("static error message") was added to eyre. This feature brings with it ergonomics parity with anyhow.

However, the feature is currently documented only under the "Compatibility with anyhow" section, where Option is discussed. This hampers discoverability.

OptionExt::ok_or_eyre's existence and usage should be documented more prominently in README.md, eyre crate-level documentation, and possibly (at release-time) published in articles(?) and / or social media posts.
@yaahc

This comment was marked as resolved.

Sign in to view
@LeoniePhiline LeoniePhiline changed the title Improve discoverability of OptionExt::unwrap_or_eyre Improve discoverability of OptionExt::ok_or_eyre Dec 6, 2023
@LeoniePhiline

This comment was marked as resolved.

Sign in to view
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@yaahc @LeoniePhiline