Skip to content

Commit

Permalink
Clean out docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alxjrvs committed Sep 20, 2024
1 parent 78221c7 commit c711a61
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 2 deletions.
2 changes: 1 addition & 1 deletion GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ console.log(result.total) // a random number between 1 and 20

### The Roll Result

`roll()` returns a `RandsumRollResult` object. This has plenty of helpful keys, but the big ones are `total` and `result`.
`roll(arg)` returns a `RandsumRollResult` object. This has plenty of helpful keys, but the big ones are `total` and `result`.

`total` returns the combined total of all your rolls, whereas `result` is an `Array` of `Array`s, each one representing the _set_ of different roll results for each pool of dice you rolled.

Expand Down
1 change: 0 additions & 1 deletion RANDSUM_DICE_NOTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ In `randsum` :
```js
// Roll 1 twenty-sided die

roll()
roll(20)
roll('1d20')
roll({
Expand Down

0 comments on commit c711a61

Please sign in to comment.