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

eyre!() docs reference "Error" instead of "Report" #53

Closed
lilyball opened this issue Jul 23, 2021 · 3 comments
Closed

eyre!() docs reference "Error" instead of "Report" #53

lilyball opened this issue Jul 23, 2021 · 3 comments
Labels
C-documentation Category: Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lilyball
Copy link

https://docs.rs/eyre/0.6.5/eyre/macro.eyre.html

https://github.com/yaahc/eyre/blob/54933ea76d12960fb4b954c81c2d288481ff9b03/src/macros.rs#L129

This appears to have been inherited from anyhow.

Also, when fixing this, it might be nice to add an intra-doc link to this reference.

@lilyball
Copy link
Author

birkenfeld added a commit to birkenfeld/eyre that referenced this issue Dec 3, 2022
@ten3roberts
Copy link
Contributor

Yes, it is likely a leftover.

To ensure that we maintain a drop-in replacement for anyhow, we have aliased the equivalent types such as Report WrapErr etc with Error, Context ...

These re-exports are either hidden or not prominent enough in docs.rs, so while they do work, it may look like the won't, and I do definitely agree that we could increase our own internal consistency and honor Report, and keep Error mostly for compatibility.

@yaahc yaahc added C-documentation Category: Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Aug 16, 2023
pksunkara pushed a commit that referenced this issue Oct 11, 2023
* owo

* kindaaa fixed it
@thenorili
Copy link
Contributor

Fixed in PR #87 -- thanks so much for your contribution :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-documentation Category: Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants