Preston_PLB
/
bubbletea
forked from Mirrors/bubbletea
1
0
Fork 0
Code Pull Requests Activity

docs: fix deprecation notes

This commit is contained in:
Christian Muehlhaeuser 2022-06-08 14:55:54 +02:00
parent f27dfb52af
commit 21de41ac02
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
tea.go
View File

@ -597,7 +597,7 @@ func (p *Program) shutdown(kill bool) {
// EnterAltScreen enters the alternate screen buffer, which consumes the entire // EnterAltScreen enters the alternate screen buffer, which consumes the entire
// terminal window. ExitAltScreen will return the terminal to its former state. // terminal window. ExitAltScreen will return the terminal to its former state.
// //
// Deprecated. Use the WithAltScreen ProgramOption instead. // Deprecated: Use the WithAltScreen ProgramOption instead.
func (p *Program) EnterAltScreen() { func (p *Program) EnterAltScreen() {
p.mtx.Lock() p.mtx.Lock()
defer p.mtx.Unlock() defer p.mtx.Unlock()
@ -616,7 +616,7 @@ func (p *Program) EnterAltScreen() {
// ExitAltScreen exits the alternate screen buffer. // ExitAltScreen exits the alternate screen buffer.
// //
// Deprecated. The altscreen will exited automatically when the program exits. // Deprecated: The altscreen will exited automatically when the program exits.
func (p *Program) ExitAltScreen() { func (p *Program) ExitAltScreen() {
p.mtx.Lock() p.mtx.Lock()
defer p.mtx.Unlock() defer p.mtx.Unlock()
@ -636,7 +636,7 @@ func (p *Program) ExitAltScreen() {
// EnableMouseCellMotion enables mouse click, release, wheel and motion events // EnableMouseCellMotion enables mouse click, release, wheel and motion events
// if a mouse button is pressed (i.e., drag events). // if a mouse button is pressed (i.e., drag events).
// //
// Deprecated. Use the WithMouseCellMotion ProgramOption instead. // Deprecated: Use the WithMouseCellMotion ProgramOption instead.
func (p *Program) EnableMouseCellMotion() { func (p *Program) EnableMouseCellMotion() {
p.mtx.Lock() p.mtx.Lock()
defer p.mtx.Unlock() defer p.mtx.Unlock()
@ -646,7 +646,7 @@ func (p *Program) EnableMouseCellMotion() {
// DisableMouseCellMotion disables Mouse Cell Motion tracking. This will be // DisableMouseCellMotion disables Mouse Cell Motion tracking. This will be
// called automatically when exiting a Bubble Tea program. // called automatically when exiting a Bubble Tea program.
// //
// Deprecated. The mouse will automatically be disabled when the program exits. // Deprecated: The mouse will automatically be disabled when the program exits.
func (p *Program) DisableMouseCellMotion() { func (p *Program) DisableMouseCellMotion() {
p.mtx.Lock() p.mtx.Lock()
defer p.mtx.Unlock() defer p.mtx.Unlock()
@ -657,7 +657,7 @@ func (p *Program) DisableMouseCellMotion() {
// regardless of whether a mouse button is pressed. Many modern terminals // regardless of whether a mouse button is pressed. Many modern terminals
// support this, but not all. // support this, but not all.
// //
// Deprecated. Use the WithMouseAllMotion ProgramOption instead. // Deprecated: Use the WithMouseAllMotion ProgramOption instead.
func (p *Program) EnableMouseAllMotion() { func (p *Program) EnableMouseAllMotion() {
p.mtx.Lock() p.mtx.Lock()
defer p.mtx.Unlock() defer p.mtx.Unlock()
@ -667,7 +667,7 @@ func (p *Program) EnableMouseAllMotion() {
// DisableMouseAllMotion disables All Motion mouse tracking. This will be // DisableMouseAllMotion disables All Motion mouse tracking. This will be
// called automatically when exiting a Bubble Tea program. // called automatically when exiting a Bubble Tea program.
// //
// Deprecated. The mouse will automatically be disabled when the program exits. // Deprecated: The mouse will automatically be disabled when the program exits.
func (p *Program) DisableMouseAllMotion() { func (p *Program) DisableMouseAllMotion() {
p.mtx.Lock() p.mtx.Lock()
defer p.mtx.Unlock() defer p.mtx.Unlock()