diff --git a/Terminal.Gui/Views/Wizard/Wizard.cs b/Terminal.Gui/Views/Wizard/Wizard.cs index 8e2b3d28f..c3263eaa8 100644 --- a/Terminal.Gui/Views/Wizard/Wizard.cs +++ b/Terminal.Gui/Views/Wizard/Wizard.cs @@ -113,14 +113,18 @@ public class Wizard : Dialog /// /// /// - /// This is a convenience property that checks if indicates the wizard was - /// finished rather than canceled. Since inherits from which - /// implements with int? result type, the - /// property contains the button index. The Finish button is added as the last button. + /// This is a convenience property that checks if the wizard was successfully completed. + /// Since inherits from which implements + /// with int? result type, the + /// property contains the button index when a button is clicked. /// /// - /// Returns if is not and equals - /// the index of the Next/Finish button, otherwise (canceled or Back button pressed). + /// Returns if both: + /// + /// is not (a button was clicked) + /// The internal _finishedPressed flag is set (the Finish button was clicked and event completed without cancellation) + /// + /// Returns if the wizard was canceled (ESC pressed), the Back button was clicked, or the event was canceled. /// /// public bool WasFinished => Result is { } && _finishedPressed;