Skip to content

Commit

Permalink
clarify that final_outcome is output and extra_outcomes is input
Browse files Browse the repository at this point in the history
  • Loading branch information
HighDiceRoller committed Sep 15, 2024
1 parent fd5a00c commit 07d4680
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/icepool/evaluator/multiset_evaluator.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def next_state(self, state: Hashable, outcome: T_contra, /, *counts:
def final_outcome(
self, final_state: Hashable
) -> 'U_co | icepool.Die[U_co] | icepool.RerollType':
"""Optional function to generate a final outcome from a final state.
"""Optional function to generate a final output outcome from a final state.
By default, the final outcome is equal to the final state.
Note that `None` is not a valid outcome for a `Die`,
Expand Down Expand Up @@ -137,7 +137,7 @@ def order(self) -> Order:

def extra_outcomes(self,
outcomes: Sequence[T_contra]) -> Collection[T_contra]:
"""Optional method to specify extra outcomes that should be seen by `next_state()`.
"""Optional method to specify extra outcomes that should be seen as inputs to `next_state()`.
These will be seen by `next_state` even if they do not appear in the
generator(s). The default implementation returns `()`, or no additional
Expand Down

0 comments on commit 07d4680

Please sign in to comment.