Skip to content

Commit

Permalink
docs: fix typos and clean up comments
Browse files Browse the repository at this point in the history
  • Loading branch information
gzipChrist authored and meowgorithm committed Feb 19, 2023
1 parent 76c3c1a commit 4880cf2
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion examples/credit-card-form/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ func ccnValidator(s string) error {

func expValidator(s string) error {
// The 3 character should be a slash (/)
// The rest thould be numbers
// The rest should be numbers
e := strings.ReplaceAll(s, "/", "")
_, err := strconv.ParseInt(e, 10, 64)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion examples/help/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ func (m model) Init() tea.Cmd {
func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
switch msg := msg.(type) {
case tea.WindowSizeMsg:
// If we set a width on the help menu it can it can gracefully truncate
// If we set a width on the help menu it can gracefully truncate
// its view as needed.
m.help.Width = msg.Width

Expand Down
2 changes: 1 addition & 1 deletion examples/simple/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
return m, nil
}

// Views return a string based on data in the model. That string which will be
// View returns a string based on data in the model. That string which will be
// rendered to the terminal.
func (m model) View() string {
return fmt.Sprintf("Hi. This program will exit in %d seconds. To quit sooner press any key.\n", m)
Expand Down
2 changes: 1 addition & 1 deletion examples/textarea/main.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package main

// A simple program demonstrating the text input component from the Bubbles
// A simple program demonstrating the textarea component from the Bubbles
// component library.

import (
Expand Down
2 changes: 1 addition & 1 deletion examples/tui-daemon-combo/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ func (m model) View() string {
return indent.String(s, 1)
}

// processFinishedMsg is send when a pretend process completes.
// processFinishedMsg is sent when a pretend process completes.
type processFinishedMsg time.Duration

// pretendProcess simulates a long-running process.
Expand Down
4 changes: 2 additions & 2 deletions mouse.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import (
"errors"
)

// MouseMsg contains information about a mouse event and are sent to a programs
// MouseMsg contains information about a mouse event and is sent to a program's
// update function when mouse activity occurs. Note that the mouse must first
// be enabled via in order the mouse events to be received.
// be enabled in order for the mouse events to be received.
type MouseMsg MouseEvent

// MouseEvent represents a mouse event, which could be a click, a scroll wheel
Expand Down
4 changes: 2 additions & 2 deletions options.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func WithInput(input io.Reader) ProgramOption {
}
}

// WithInputTTY open a new TTY for input (or console input device on Windows).
// WithInputTTY opens a new TTY for input (or console input device on Windows).
func WithInputTTY() ProgramOption {
return func(p *Program) {
p.startupOptions |= withInputTTY
Expand Down Expand Up @@ -144,7 +144,7 @@ func WithoutRenderer() ProgramOption {
// WithANSICompressor removes redundant ANSI sequences to produce potentially
// smaller output, at the cost of some processing overhead.
//
// This feature is provisional, and may be changed removed in a future version
// This feature is provisional, and may be changed or removed in a future version
// of this package.
func WithANSICompressor() ProgramOption {
return func(p *Program) {
Expand Down
4 changes: 2 additions & 2 deletions tutorials/basics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func initialModel() model {
choices: []string{"Buy carrots", "Buy celery", "Buy kohlrabi"},

// A map which indicates which choices are selected. We're using
// the map like a mathematical set. The keys refer to the indexes
// the map like a mathematical set. The keys refer to the indexes
// of the `choices` slice, above.
selected: make(map[int]struct{}),
}
Expand Down Expand Up @@ -154,7 +154,7 @@ the Bubble Tea runtime to quit, exiting the program.

At last, it’s time to render our UI. Of all the methods, the view is the
simplest. We look at the model in its current state and use it to return
a `string`. That string is our UI!
a `string`. That string is our UI!

Because the view describes the entire UI of your application, you don’t have to
worry about redrawing logic and stuff like that. Bubble Tea takes care of it
Expand Down
2 changes: 1 addition & 1 deletion tutorials/basics/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ func initialModel() model {
choices: []string{"Buy carrots", "Buy celery", "Buy kohlrabi"},

// A map which indicates which choices are selected. We're using
// the map like a mathematical set. The keys refer to the indexes
// the map like a mathematical set. The keys refer to the indexes
// of the `choices` slice, above.
selected: make(map[int]struct{}),
}
Expand Down

0 comments on commit 4880cf2

Please sign in to comment.