Skip to content

Commit

Permalink
Use full names for some types in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Gawdl3y committed Apr 24, 2024
1 parent 80d3c5d commit 08ba03d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ let rolled = roller.roll(&dice, true)?;

Rolling a single die results in a `DieRoll` instance, whereas rolling a set of `Dice` returns a `Rolled` instance.

#### Working with Rolled dice sets
#### Working with rolled dice sets

`Rolled` is a struct that ties multiple `DieRoll`s together with the `Dice` that were rolled to generate them so it can
accurately describe what happened during the roll and application of any modifiers that were on the dice.
Expand Down Expand Up @@ -189,7 +189,7 @@ let described = rolled.to_string();
let limited = rolled.describe(Some(2));
```

#### Working with individual DieRolls
#### Working with individual die rolls

A `DieRoll` contains the final value of the die alongside information about any changes that were made to it and the
source of said changes.
Expand All @@ -211,17 +211,17 @@ modifiers, is not included when totaling the rolled set, and will be marked as d
Modifiers that can result in dropped die rolls are:

- Reroll
- KeepHigh
- KeepLow
- Keep highest
- Keep lowest

##### Changed rolls

When a modifier directly manipulates the value of a `DieRoll` in a `Rolled` set, the roll's `changes` field has a
`ValChange` item added to it that describes the change made and the modifier that caused it.
Modifiers that can result in changed die rolls are:

- Min
- Max
- Minimum
- Maximum

### Working with expressions

Expand Down

0 comments on commit 08ba03d

Please sign in to comment.