Implement Iterator#zipLongest and improve zip description #349
Conversation
lundibundi
force-pushed
the
impl-zip-longest
branch
from
e9e5b4e
to
3a76087
Compare
lib/iterator.js
Outdated
| // Returns an iterator of Arrays where the i-th tuple contains | ||
| // the i-th element from each of the passed iterators. | ||
| // The iterator stops when the shortest input iterable is exhausted. | ||
| // Signature: base, ...iterators |
There was a problem hiding this comment.
It was written this way to specifically hide the implementation detail of having a separate argument which has the same meaning as every other
| // Signature: base, ...iterators | |
| // Signature: ...iterators |
lib/iterator.js
Outdated
| // If the iterables are of uneven length, missing values are filled-in | ||
| // with <undefined>. Iteration continues until the longest iterable | ||
| // is exhausted. | ||
| // Signature: base, ...iterators |
There was a problem hiding this comment.
| // Signature: base, ...iterators | |
| // Signature: ...iterators |
lib/iterator.js
Outdated
| // Returns an iterator of Arrays where the i-th tuple contains | ||
| // the i-th element from each of the passed iterators. | ||
| // The iterator stops when the shortest input iterable is exhausted. | ||
| // Signature: ...iterators |
There was a problem hiding this comment.
No need for the signature change when the default is correct
| // Signature: ...iterators |
There was a problem hiding this comment.
The metadoc will generate zip(iterators)
lib/iterator.js
Outdated
| // If the iterables are of uneven length, missing values are filled-in | ||
| // with <undefined>. Iteration continues until the longest iterable | ||
| // is exhausted. | ||
| // Signature: ...iterators |
There was a problem hiding this comment.
Ditto
| // Signature: ...iterators |
| // Signature: ...iterators | ||
| // iterators <Array> | ||
| // Returns: <Iterator> | ||
| zipLongest(...iterators) { |
There was a problem hiding this comment.
I think we should allow specifying the value that should be used to fill with when there are no values left in one of the iterators.
There was a problem hiding this comment.
Yeah, I couldn't devise a way to make a proper API.
lundibundi
force-pushed
the
impl-zip-longest
branch
from
3a76087
to
99b935f
Compare
Creates an iterator that aggregates elements from each of the iterators. If the iterables are of uneven length, missing values are filled-in with undefined or provided defaultValue. Iteration continues until the longest iterable is exhausted.
lundibundi
force-pushed
the
impl-zip-longest
branch
from
99b935f
to
e978d0b
Compare
belochub
added
the
semver-minor
| // | ||
| // Returns an iterator of Arrays where the i-th tuple contains | ||
| // the i-th element from each of the passed iterators. | ||
| // The iterator stops when the shortest input iterable is exhausted. |
There was a problem hiding this comment.
Here and in other places where you're mentioning the iterable protocol in combination with "exhausting", you should use the iterator contract instead since iterable only requires for an object to have a function that returns an iterator, while the iterator is an actual object that has a next() method and that can be "exhausted" by calling that method.
| // The iterator stops when the shortest input iterable is exhausted. | |
| // The iterator stops when the shortest input iterator is exhausted. |
npm run fmt)npm run docto regenerate documentation based on comments)Unreleasedheader in CHANGELOG.mdRefs: https://docs.python.org/3.0/library/itertools.html#itertools.zip_longest