chore(exec): disambiguate methods for restoring the terminal state vs…

… input
charmbracelet · Apr 7, 2022 · f5ff931 · f5ff931
1 parent 8e380dc
commit f5ff931
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/tea.go b/tea.go
@@ -628,7 +628,7 @@ func (p *Program) shutdown(kill bool) {
 	p.ExitAltScreen()
 	p.DisableMouseCellMotion()
 	p.DisableMouseAllMotion()
-	_ = p.restoreTerminal()
+	_ = p.restoreTerminalState()
 }
 
 // EnterAltScreen enters the alternate screen buffer, which consumes the entire
@@ -721,7 +721,7 @@ func (p *Program) ReleaseTerminal() error {
 		p.ExitAltScreen()
 		time.Sleep(time.Millisecond * 10) // give the terminal a moment to catch up
 	}
-	return p.restoreTerminal()
+	return p.restoreTerminalState()
 }
 
 // RestoreTerminal reinitializes the Program's input reader, restores the

diff --git a/tty.go b/tty.go
@@ -24,7 +24,9 @@ func (p *Program) initTerminal() error {
 	return nil
 }
 
-func (p Program) restoreTerminal() error {
+// restoreTerminalState restores the terminal to the state prior to running the
+// Bubble Tea program.
+func (p Program) restoreTerminalState() error {
 	showCursor(p.output)
 
 	if p.console != nil {