Skip to content

Commit

Permalink
docs: Stress inclusivity of create.range()
Browse files Browse the repository at this point in the history
  • Loading branch information
jajaperson committed Aug 24, 2022
1 parent 6222a5b commit 35072da
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ and this project adheres to

- `iter.peekable()` inspired by Rust's [`std::iter::Peekable`](https://doc.rust-lang.org/std/iter/struct.Peekable.html).

## Changed

- (docs) Added special note on the inclusivity of `create.range()`.

## [2.5.0] - 2020-08-12

### Added
Expand Down
4 changes: 3 additions & 1 deletion lib/generators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,9 @@ export function increments(initial = 0, step = 1): IterableCircular<number> {
* Creates an iterable over an inclusive range of numbers.
* @param endOrStart - If no other arguments are provided, the range will go
* from 0 until `endOrRangeStart`. Otherwise, this acts as the start of the
* range.
* range. To stress, this is _inclusive_, in contrast to Python's
* [`range()`](https://docs.python.org/3.10/library/stdtypes.html?highlight=range#range)
* iterables.
* @param end - The end of the range.
* @param step - The amount to increment each time. Sign is ignored.
* @returns An iterable over the range.
Expand Down

0 comments on commit 35072da

Please sign in to comment.