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

Documentation suggests that `==` works on tasks, but it doesn't #502

Closed
jvoigtlaender opened this Issue Feb 12, 2016 · 2 comments

Comments

Projects
None yet
2 participants
@jvoigtlaender
Contributor

jvoigtlaender commented Feb 12, 2016

For example, the documentation of Task.map2 (http://package.elm-lang.org/packages/elm-lang/core/3.0.0/Task#map2) contains this line:

map2 (+) (succeed 9) (succeed 3) == succeed 12

However, issuing that exact line in a program will actually evaluate to False. Very confusing, for example to @paparga here.

Maybe the documentation shouldn't be using == on tasks, and indeed maybe it should explicitly mention that == is wonky on tasks, as the documentation already says elsewhere about Dict etc.

(Note: For Dict etc., equality could potentially be made unwonky, but for tasks not.)

@halfzebra

This comment has been minimized.

Show comment
Hide comment
@halfzebra

halfzebra Apr 10, 2016

Contributor

Here's my take on fixing those confusing in docs #557

Contributor

halfzebra commented Apr 10, 2016

Here's my take on fixing those confusing in docs #557

@jvoigtlaender

This comment has been minimized.

Show comment
Hide comment
@jvoigtlaender

jvoigtlaender Apr 11, 2016

Contributor

Thanks, I like your changes there!

I'll copy my original comment from above to the opening comment over there, so that Evan sees it all in one place when reviewing the PR.

Contributor

jvoigtlaender commented Apr 11, 2016

Thanks, I like your changes there!

I'll copy my original comment from above to the opening comment over there, so that Evan sees it all in one place when reviewing the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment