forked from Mirrors/bubbletea
docs: fix spelling / various typos (#526)
This commit is contained in:
parent
8703897aad
commit
4aa9ce489b
|
@ -40,7 +40,7 @@ func Sequence(cmds ...Cmd) Cmd {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// sequenceMsg is used interally to run the the given commands in order.
|
// sequenceMsg is used interally to run the given commands in order.
|
||||||
type sequenceMsg []Cmd
|
type sequenceMsg []Cmd
|
||||||
|
|
||||||
// Every is a command that ticks in sync with the system clock. So, if you
|
// Every is a command that ticks in sync with the system clock. So, if you
|
||||||
|
|
|
@ -7,7 +7,7 @@ package main
|
||||||
// by the Tick command.
|
// by the Tick command.
|
||||||
//
|
//
|
||||||
// In a subsequent Update, if the tag in the Msg matches current tag on the
|
// In a subsequent Update, if the tag in the Msg matches current tag on the
|
||||||
// model's state we know that the debouncing is complete and we can proceeed as
|
// model's state we know that the debouncing is complete and we can proceed as
|
||||||
// normal. If not, we simply ignore the inbound message.
|
// normal. If not, we simply ignore the inbound message.
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -7,7 +7,7 @@ A casual introduction. 你好世界!
|
||||||
|
|
||||||
The _artichoke_ is mentioned as a garden plant in the 8th century BC by Homer
|
The _artichoke_ is mentioned as a garden plant in the 8th century BC by Homer
|
||||||
**and** Hesiod. The naturally occurring variant of the artichoke, the cardoon,
|
**and** Hesiod. The naturally occurring variant of the artichoke, the cardoon,
|
||||||
which is native the the Mediterranean area, also has records of use as a food
|
which is native to the Mediterranean area, also has records of use as a food
|
||||||
among the ancient Greeks and Romans. Pliny the Elder mentioned growing of
|
among the ancient Greeks and Romans. Pliny the Elder mentioned growing of
|
||||||
_carduus_ in Carthage and Cordoba.
|
_carduus_ in Carthage and Cordoba.
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
package main
|
package main
|
||||||
|
|
||||||
// An example illustating how to pipe in data to a Bubble Tea application.
|
// An example illustrating how to pipe in data to a Bubble Tea application.
|
||||||
// Moreso, this serves as proof that Bubble Tea will automatically listen for
|
// Moreso, this serves as proof that Bubble Tea will automatically listen for
|
||||||
// keystrokes when input is not a TTY, such as when data is piped or redirected
|
// keystrokes when input is not a TTY, such as when data is piped or redirected
|
||||||
// in.
|
// in.
|
||||||
|
|
2
exec.go
2
exec.go
|
@ -13,7 +13,7 @@ type execMsg struct {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Exec is used to perform arbitrary I/O in a blocking fashion, effectively
|
// Exec is used to perform arbitrary I/O in a blocking fashion, effectively
|
||||||
// pausing the Program while execution is runnning and resuming it when
|
// pausing the Program while execution is running and resuming it when
|
||||||
// execution has completed.
|
// execution has completed.
|
||||||
//
|
//
|
||||||
// Most of the time you'll want to use ExecProcess, which runs an exec.Cmd.
|
// Most of the time you'll want to use ExecProcess, which runs an exec.Cmd.
|
||||||
|
|
|
@ -90,7 +90,7 @@ func DisableMouse() Msg {
|
||||||
return disableMouseMsg{}
|
return disableMouseMsg{}
|
||||||
}
|
}
|
||||||
|
|
||||||
// disableMouseMsg is an internal message that that signals to stop listening
|
// disableMouseMsg is an internal message that signals to stop listening
|
||||||
// for mouse events. To send a disableMouseMsg, use the DisableMouse command.
|
// for mouse events. To send a disableMouseMsg, use the DisableMouse command.
|
||||||
type disableMouseMsg struct{}
|
type disableMouseMsg struct{}
|
||||||
|
|
||||||
|
|
2
tea.go
2
tea.go
|
@ -497,7 +497,7 @@ func (p *Program) Start() error {
|
||||||
// messages to be injected from outside the program for interoperability
|
// messages to be injected from outside the program for interoperability
|
||||||
// purposes.
|
// purposes.
|
||||||
//
|
//
|
||||||
// If the program is not running this this will be a no-op, so it's safe to
|
// If the program is not running this will be a no-op, so it's safe to
|
||||||
// send messages if the program is unstarted, or has exited.
|
// send messages if the program is unstarted, or has exited.
|
||||||
func (p *Program) Send(msg Msg) {
|
func (p *Program) Send(msg Msg) {
|
||||||
p.msgs <- msg
|
p.msgs <- msg
|
||||||
|
|
Loading…
Reference in New Issue