Skip to content

Commit

Permalink
Updated collections documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
gcotelli committed Mar 28, 2017
1 parent a3e8415 commit 857e574
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ This library provides basic arithmetic abstractions like Percentages. See the [r

This library provides support to express optional values and required values, that can be unknown at the beginning of an execution. See the [related documentation.](docs/BindingsAndOptionals.md)

## Collections

This library provides additional abstractions for Collections. See the [related documentation.](docs/Collections.md)

## Contributing

If you want to help check the [contribution guidelines.](CONTRIBUTING.md)
Expand Down
15 changes: 15 additions & 0 deletions docs/Collections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Collections

## Circular Iterator

A `CircularIterator` provides an abstraction to iterate over a collection rolling over when the end is reached:

```smalltalk
| iterator |
iterator := CircularIterator cyclingOver: 'abc'.
iterator next "$a".
iterator next "$b".
iterator next "$c".
iterator next "$a".
iterator next "$b".
```

0 comments on commit 857e574

Please sign in to comment.