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

Add some examples/rationale at the top of the documentation *why* one might want to use Either and what for #45

Open
sdroege opened this issue May 20, 2020 · 4 comments

Comments

@sdroege
Copy link

sdroege commented May 20, 2020

It's all very generic, so for users ending up at the documentation it's not entirely clear what this is actually good for. Why would one want a type that is like Result but unbiased?

No need to answer that in the issue, I know but having this in the documentation in an understandable way would be useful :)

@bluss
Copy link
Contributor

bluss commented May 20, 2020

It's not like Result, so whoever writes the PR, don't start with comparing to Result.

@sdroege
Copy link
Author

sdroege commented May 20, 2020

Indeed, that's part of the problem, the docs say to use Result for describing errors and that Either is general purpose... but not what kind of purposes for example it would be useful for :)

I don't have any good suggestion how to write those docs though, I'm not good with writing docs.

@maugier
Copy link

maugier commented Feb 1, 2021

I found this crate after specifically looking for this exact Iterator implementation, so, for me, that was the compelling use case.

@jost-s
Copy link

jost-s commented Sep 21, 2023

I found this crate being used in a large codebase and had/have no clue what it does. Reading the introduction didn't clarify it for me, it's too abstract and generic without a use case or example. I would also welcome an explanation of what a "sum type" is.

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

4 participants