Skip to content

Commit

Permalink
doc: improve documentation & fixing typos
Browse files Browse the repository at this point in the history
  • Loading branch information
xgbuils committed Aug 1, 2017
1 parent 370c6ef commit 13665e4
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 92 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ for (let x of obj) {
}
```

Then, `obj` can be processed as a ordered list of values. However, unlike [built-in iterables](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#Built-in_iterables) (Array, Set, Map, String, etc), `obj` is a **lazy iterable**. It means that, thanks to generators, `obj` does not store the computed values in memory and its values are computed just when are required. These are the essential features for implementing lazy evaluation.
Then, `obj` can be processed as an ordered list of values. However, unlike [built-in iterables](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#Built-in_iterables) (Array, Set, Map, String, etc), `obj` is a **lazy iterable**. It means that, thanks to generators, `obj` does not store the computed values in memory and its values are computed just when are required. These are the essential features for implementing lazy evaluation.

It is even possible to create a new iterable without computing or storing `obj` values in memory. This is an example of creating a new iterable that iterates over the double of values generated by `obj`:

Expand All @@ -84,7 +84,7 @@ let doubleObj = {
[...doubleObj] // returns [0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20]
```

`iterum` is a library that takes advantage of these techniques to provide a collection of functions and methods that apply iterable transformations without traversing values. Then, using `iterum` the previous example could be expressed thus:
`iterum` is a library that takes advantage of these techniques to provide a collection of functions and methods that apply iterable transformations without traversing values. Then, using `iterum`, the previous example could be expressed thus:

``` javascript
const Iterum = require('iterum')
Expand All @@ -110,7 +110,7 @@ const doubleObj = obj.map(e => 2 * e) // (0 2 4 6 8 10 12 14 16 18 20)
- ES2015 transpilers

## Customized builds
`Iterum` allows to build just what you need. Read [customized build section](doc/customized_builds.md) for more information
`Iterum` allows to build just what you need. Read [customized build section](doc/customized_builds.md) for more information.

## Contributors
- [xgbuils](https://github.com/xgbuils)
Expand Down

0 comments on commit 13665e4

Please sign in to comment.