From 07d4680e91ae304d2152fe506e3eed529c88e3cd Mon Sep 17 00:00:00 2001 From: Albert Julius Liu Date: Sun, 15 Sep 2024 00:25:55 -0700 Subject: [PATCH] clarify that `final_outcome` is output and `extra_outcomes` is input --- src/icepool/evaluator/multiset_evaluator.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/icepool/evaluator/multiset_evaluator.py b/src/icepool/evaluator/multiset_evaluator.py index 405566bd..7821e05c 100644 --- a/src/icepool/evaluator/multiset_evaluator.py +++ b/src/icepool/evaluator/multiset_evaluator.py @@ -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`, @@ -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