docs: Program#Send, Program#Quit, and Program#Kill no longer provisional

This commit is contained in:
Christian Rocha
2022-03-31 14:33:17 -04:00
parent 5c76027b36
commit 9a1310846c

9
tea.go
View File

@@ -563,9 +563,6 @@ func (p *Program) Start() error {
//
// If the program is not running this this will be a no-op, so it's safe to
// send messages if the program is unstarted, or has exited.
//
// This method is currently provisional. The method signature may alter
// slightly, or it may be removed in a future version of this package.
func (p *Program) Send(msg Msg) {
p.msgs <- msg
}
@@ -577,18 +574,12 @@ func (p *Program) Send(msg Msg) {
//
// If the program is not running this will be a no-op, so it's safe to call
// if the program is unstarted or has already exited.
//
// This method is currently provisional. The method signature may alter
// slightly, or it may be removed in a future version of this package.
func (p *Program) Quit() {
p.Send(Quit())
}
// Kill stops the program immediately and restores the former terminal state.
// The final render that you would normally see when quitting will be skipped.
//
// This method is currently provisional. The method signature may alter
// slightly, or it may be removed in a future version of this package.
func (p *Program) Kill() {
p.killc <- true
p.shutdown(true)