From 649e5202d4576185b763babb6806f0329b540084 Mon Sep 17 00:00:00 2001 From: Germain Date: Thu, 31 Aug 2023 14:01:23 +0100 Subject: [PATCH] Clarifying documentation for setPhase --- src/utils/room/setPhase.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/utils/room/setPhase.ts b/src/utils/room/setPhase.ts index eb42209857..2d2941286c 100644 --- a/src/utils/room/setPhase.ts +++ b/src/utils/room/setPhase.ts @@ -19,7 +19,11 @@ import { IRightPanelCardState } from "../../stores/right-panel/RightPanelStoreIP import { RightPanelPhases } from "../../stores/right-panel/RightPanelStorePhases"; /** - * Helper to toggle a right panel view. + * Helper to show a right panel phase. + * If the UI is already showing that phase, the right panel will be hidden. + * + * Calling the same phase twice with a different state will update the current + * phase and push the old state in the right panel history. * @param phase The right panel phase. * @param cardState The state within the phase. */