Updating roll doc

2021-09-17 22:08:51 -04:00 · 2021-09-17 22:08:51 -04:00 · 1992ef4e08
parent f904e3a948
commit 1992ef4e08
1 changed files with 3 additions and 1 deletions
--- a/dicebot/src/basic/roll.rs
+++ b/dicebot/src/basic/roll.rs
@ -19,7 +19,9 @@ pub trait Rolled {
 }

 #[derive(Debug, PartialEq, Eq, Clone)]
-// array of rolls in order, how many dice to keep, and how many to drop
+/// array of rolls in order, how many dice to keep, and how many to drop
+///   keep indicates how many of the highest dice to keep
+///   drop indicates how many of the highest dice to drop
 pub struct DiceRoll (pub Vec<u32>, usize, usize);

 impl DiceRoll {