Imported From: https://issues.scala-lang.org/browse/SI-8394?orig=1
Reporter: scalauserxxi (xiu)
Affected Versions: 2.10.3
See #8391

@gourlaysama said:
It is a scaladoc bug in the way the usecase (fake) signature of zip is generated:

If you look at the full signature in the Scaladoc for Option (expand the zip method in the doc and then expand the "fullSignature" section at the bottom), you will see that there are no Option type involved. And there cannot be since Option does not implement zip, Iterable does (and there is an implicit conversion from Option to Iterable).

Markus Klink (justjoheinz) said:
Given that we can zip all kinds of things, and get a Thing[(a,b)] this behavior is at least inconsistent. Would be nice if Option would implement zip properly.

Naftoli Gugenheim (naftoligug) said:
Forget about the documentation, why can't it return an Option? Isn't it just a matter of adding a zip method to Option?

Heikki Vesalainen (hvesalai) said:
+1 on zip returning Option instead of Iterable

Mehmet Ali Gözaydın (kubudi) said:
I opened a PR for this: #4433
I would be happy to hear from you

Vera Salvisberg (vsalvis) said (edited on Jun 4, 2015 9:40:02 AM UTC):
Updated PR by Mehmet Ali Gözaydın ready to be merged: scala/scala#4437

@SethTisue said:
4437 was replaced with scala/scala#4836

but, I'm afraid the Scala team doesn't consider this issue addressable in 2.12, given our 2.12 compatibility promises; maybe for 2.13? see my comments at scala/scala#4836 (comment)

@SethTisue said (edited on Oct 13, 2016 5:38:29 AM UTC):
It's unclear now whether this a ticket about adding Option.zip specifically, or about doing something about the Scaladoc issue more generally (which affects other collections methods, see linked issues), or both. Let's be careful not to close this until either both issues are fixed, or a separate ticket for one has been created.

Heikki Vesalainen (hvesalai) said:
I think the description of this issue answers the question above: " I don't think it's a documentation bug, as returning an Option would make sense.", i.e. this issue is about Option.zip not returning Option (which would make sense).

Fixing this would take marshaling the old patch scala/scala#4433 new patch scala/scala#6491 by Dale Wijnand that adds Option.zip and works on 2.13 and includes tests.

Is this a good first issue?

Dale isn't working on scala/scala#6491 anymore, he says. Would someone else like to take it?

I've removed "good first issue" since there is now enough accumulated history and discussion on this to be potentially intimidating to a newcomer. Regardless, it's not a big change and shouldn't be hard for someone to pick up, assuming there aren't new objections to what seems to me (knock on wood) like emerging consensus on the PR about what the right design is.

(And I've redone the labels to show that this is now about changing Option for 2.13, not about fixing Scaladoc. Someone might like to open a new ticket on the Scaladoc angle on this.)

scala/scala#6491 seems to be moving again