BooleanCat / go-functional

go-functional is a library of iterators to augment the standard library
MIT License
447 stars 23 forks source link

Significantly improve docs in README (partial) #132

Closed BooleanCat closed 2 months ago

BooleanCat commented 2 months ago

Please provide a brief description of the change.

Much improved docs for READ, well at least the beginnings of it. Will follow up with more changes to add more missing docs.

Which issue does this change relate to?

None.

Contribution checklist.

Additional context

Within this change are a few others mixed in, my bad!

  1. I removed TryCollect from itx for consistency.
  2. I renamed Reduce to Fold. I'll later add a Fold variant called Reduce that uses the first item yielded as the initial value (just like Rust)
codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (5351fab) to head (75d4c5d).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #132 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 32 32 Lines 407 405 -2 ========================================= - Hits 407 405 -2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.