make firstrest an alias for Iterators.peel

[nsajko]

Iterators.peel is supported on all Julia versions supported by IterTools. In fact, it was already present with Julia v0.7.

Make firstrest an alias for Iterators.peel. This is a feature addition, making firstrest return nothing instead of throwing for an empty iterator input.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.14%. Comparing base (600de09) to head (1c61fb9).

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #130      +/-   ##
==========================================
- Coverage   91.28%   91.14%   -0.14%     
==========================================
  Files           1        1              
  Lines         390      384       -6     
==========================================
- Hits          356      350       -6     
  Misses         34       34              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[omus]

Should firstrest be deprecated in favor of Iterators.peel?

[nsajko]

The doc string of firstrest points to Iterators.peel anyway. IMO there is no need to deprecate, but definitely delete firstrest at the time of a breaking release.

[oxinabox]

IMO there is no need to deprecate, but definitely delete firstrest at the time of a breaking release.

Sounds like a good reason to deprecate now

[nsajko]

Another option is to simply define firstrest as:

const firstrest = Iterators.peel

The only difference in behavior would be firstrest(empty_iterator) returning nothing instead of throwing.

[nsajko]

IMO that would be a feature addition, as opposed to a breaking change.