Skip to content

Commit d323748

Browse files
committed
docs: typos
1 parent 37b7745 commit d323748

File tree

9 files changed

+13
-13
lines changed

9 files changed

+13
-13
lines changed

docs/src/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ This is useful because you can represent lots of things as a `Stream`:
8080

8181
Streams can be composed and form pipes of arbitrary complexity. For example, `cy` records terminal sessions by proxying a `Stream` (sort of like `tee`.)
8282

83-
However, for a terminal multiplexer this is clearly not enough. A `Stream` is stateless. In other words, there is no way to know what the state of the terminal that is attached to that `Stream`. That's where `Screen`s come in.
83+
However, for a terminal multiplexer this is clearly not enough. A `Stream` is stateless. In other words, there is no way to know the state of the terminal that is attached to that `Stream`. That's where `Screen`s come in.
8484

8585
### Screen
8686

@@ -142,7 +142,7 @@ The flow for client input works like this:
142142

143143
The flow for client output is somewhat simpler:
144144

145-
1. Whenever the `Screen` the `Client` is attached to changes in some way (in other words, it produces an event that is published to its subscribers via `Subscribe`).
145+
1. The `Screen` the `Client` is attached to changes in some way (in other words, it produces an event that is published to its subscribers via `Subscribe`).
146146
2. The client's [`Renderer`](https://github.com/cfoust/cy/blob/main/pkg/mux/stream/renderer/module.go?plain=1#L24) receives this event and calls `State()` on the client's `Screen`, which produces a `tty.State`. The `Renderer` then calculates the sequence of bytes necessary to transform the actual client's terminal screen to match the `cy` server's state.
147147
3. This byte string is sent via the aforementioned WebSocket connection.
148148
4. It is ultimately `Read` by the user's terminal and written to standard output, thus triggering the visual changes the user expects.

docs/src/command-history.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ You must explicitly configure your shell (or any other program) to emit OSC-7 se
5252

5353
## How does it work?
5454

55-
A terminal multiplexer is like a proxy: it is an intermediary between your actual terminal and one or more virtual terminals that it controls. It also responsible for passing the output a program (such as a shell) produces to its corresponding terminal. This control means that your terminal multiplexer can do whatever calculations it wants on that output, including (in `cy`'s case) recording it.
55+
A terminal multiplexer is like a proxy: it is an intermediary between your actual terminal and one or more virtual terminals that it controls. It is also responsible for passing the output that a program (such as a shell) produces to its corresponding terminal. This control means that your terminal multiplexer can do whatever calculations it wants on that output, including (in `cy`'s case) recording it.
5656

5757
`cy` uses this ability to observe the state of the terminal before and after interpreting the output of the underlying process (otherwise known as a write made to standard output or error).
5858

docs/src/groups-and-panes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A **pane** refers to a terminal window with a process running inside it, typical
88

99
## Groups
1010

11-
Every pane `cy` belongs to a **group**. A group has a name and children, which consist of either panes or other groups.
11+
Every pane in `cy` belongs to a **group**. A group has a name and children, which consist of either panes or other groups.
1212

1313
Groups also have two unique features:
1414

docs/src/quick-start/the-layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The layout shown above has a single pane that has its horizontal size fixed to 8
1414

1515
{{story cast quick-start/layout --width 120 --height 26}}
1616

17-
`cy`'s has pane and split functionality that should feel familiar to users of tmux. Like other terminal multiplexers, in `cy` you can divide your screen up into any number of panes. This can be done with {{bind :root ctrl+a -}} to split the current pane along a horizontal line and {{bind :root ctrl+a |}} to split along a vertical one.
17+
`cy` has pane and split functionality that should feel familiar to users of tmux. Like other terminal multiplexers, in `cy` you can divide your screen up into any number of panes. This can be done with {{bind :root ctrl+a -}} to split the current pane along a horizontal line and {{bind :root ctrl+a |}} to split along a vertical one.
1818

1919
After creating a few, you can move between them using directional keys:
2020

docs/src/replay-mode/modes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Copy mode also allows you to swap between the terminal's main and alt screens us
4242

4343
#### Visual mode
4444

45-
Visual mode is initiated when you press {{bind :copy v}} (by default). It works almost exactly like `vim`'s visual mode does; after you have some selected some text, you can yank it into your buffer with {{bind :copy y}} and paste it elsewhere with {{bind :root ctrl+a P}}.
45+
Visual mode is initiated when you press {{bind :copy v}} (by default). It works almost exactly like `vim`'s visual mode does; after you have selected some text, you can yank it into your buffer with {{bind :copy y}} and paste it elsewhere with {{bind :root ctrl+a P}}.
4646

4747
#### Registers
4848

pkg/cy/api/docs-cmd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Some examples:
2020

2121
(cmd/path target)
2222

23-
Get the working directory of the program running in the pane pane specified by `target`. `target` is a [NodeID](/api.md#nodeid).
23+
Get the working directory of the program running in the pane specified by `target`. `target` is a [NodeID](/api.md#nodeid).
2424

2525
# doc: Title
2626

@@ -42,7 +42,7 @@ Get the commands executed in a particular pane. Returns an array of [Commands](/
4242

4343
# doc: Query
4444

45-
Query all of the commands stored in the [commmand database](/command-history.md).
45+
Query all of the commands stored in the [command database](/command-history.md).
4646

4747
# doc: Kill
4848

pkg/cy/api/docs-input.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ This function supports a range of named parameters that adjust its functionality
1111
- `:animated` (boolean): Enable and disable background animation.
1212
- `:case-sensitive` (boolean): Whether the matching algorithm should respect differences in case. The default is `false`.
1313
- `:full` (boolean): If true, occupy the entire screen.
14-
- `:headers` ([]string): Provide a title for each column. This mostly used for filtering tabular data.
14+
- `:headers` ([]string): Provide a title for each column. This is mostly used for filtering tabular data.
1515
- `:prompt` (string): The text that will be shown beneath the search window.
1616
- `:reverse` (boolean): Display from the top of the screen (rather than the bottom.)
1717
- `:width` (int): Set the width of the match window (if not in full screen mode.)
18-
- `:height` (int): Set the maximum height of the match window. This applies bth in full screen and floating mode.
18+
- `:height` (int): Set the maximum height of the match window. This applies both in full screen and floating mode.
1919

2020
# doc: Text
2121

pkg/cy/api/docs-replay.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Move cursor up one cell.
7676

7777
Set the playback rate to `rate`. Positive numbers indicate a multiplier of real time moving _forwards_, negative numbers, _backwards_. For example, a rate of `2` means that time will advance at twice the normal speed; `-2` means that time will go backwards at -2x.
7878

79-
`rate` is clamped to the range [10, 10].
79+
`rate` is clamped to the range [-10, 10].
8080

8181
# doc: Copy
8282

@@ -116,7 +116,7 @@ Jump to the cell before `char` after the cursor on the current line.
116116

117117
(replay/jump-to-backward char)
118118

119-
Jump to the cell before `char` after the cursor on the current line.
119+
Jump to the cell after `char` before the cursor on the current line.
120120

121121
# doc: Open
122122

pkg/cy/api/docs-tree.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Get the path of `node`, which is a [NodeID](/api.md#nodeid).
3232

3333
(tree/parent node)
3434

35-
Get the [NodeID](/api.md#nodeid) for the parent of `node`. If `node` is `:root`, return `(tree/parent)` returns `nil`.
35+
Get the [NodeID](/api.md#nodeid) for the parent of `node`. If `node` is `:root`, `(tree/parent)` returns `nil`.
3636

3737
# doc: Rm
3838

0 commit comments

Comments
 (0)