Skip to content

Commit

Permalink
docs: fix typos (#1481)
Browse files Browse the repository at this point in the history
  • Loading branch information
kianmeng authored Jun 10, 2022
1 parent edac2eb commit 16b53aa
Show file tree
Hide file tree
Showing 14 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ that loads the `compact-bar`. (https://github.com/zellij-org/zellij/pull/1450)
* Fix: handle pasted text properly in windows terminal (https://github.com/zellij-org/zellij/pull/917)
* Fix: update example config options (https://github.com/zellij-org/zellij/pull/920)
* Fix: correct handling of unbinds (https://github.com/zellij-org/zellij/issues/923)
* Fix: improve perfomance when resizing window with a large scrollback buffer (https://github.com/zellij-org/zellij/pull/895)
* Fix: improve performance when resizing window with a large scrollback buffer (https://github.com/zellij-org/zellij/pull/895)
* Fix: support multiple users in plugins (https://github.com/zellij-org/zellij/pull/930)
* Fix: update default layouts (https://github.com/zellij-org/zellij/pull/926)
* Add: infrastructure to show distinct tips in the `status-bar` plugin (https://github.com/zellij-org/zellij/pull/926)
Expand All @@ -183,7 +183,7 @@ that loads the `compact-bar`. (https://github.com/zellij-org/zellij/pull/1450)
## [0.21.0] - 2021-11-29
* Add: initial preparations for overlay's (https://github.com/zellij-org/zellij/pull/871)
* Add: initial `zellij.desktop` file (https://github.com/zellij-org/zellij/pull/870)
* Add: section for third party repositiories `THIRD_PARTY_INSTALL.md` (https://github.com/zellij-org/zellij/pull/857)
* Add: section for third party repositories `THIRD_PARTY_INSTALL.md` (https://github.com/zellij-org/zellij/pull/857)
* Add: suggestion for similar session name, on attach (https://github.com/zellij-org/zellij/pull/843)
* Fix: handling and overwriting options through the cli (https://github.com/zellij-org/zellij/pull/859)

Expand Down
2 changes: 1 addition & 1 deletion default-plugins/compact-bar/src/line.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ fn populate_tabs_in_tab_line(
let left_fits = size_by_adding_left <= cols;
let right_fits = size_by_adding_right <= cols;
// active tab is kept in the middle by adding to the side that
// has less width, or if the tab on the other side doesn' fit
// has less width, or if the tab on the other side doesn't fit
if (total_left <= total_right || !right_fits) && left_fits {
// add left tab
let tab = tabs_before_active.pop().unwrap();
Expand Down
2 changes: 1 addition & 1 deletion default-plugins/tab-bar/src/line.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ fn populate_tabs_in_tab_line(
let left_fits = size_by_adding_left <= cols;
let right_fits = size_by_adding_right <= cols;
// active tab is kept in the middle by adding to the side that
// has less width, or if the tab on the other side doesn' fit
// has less width, or if the tab on the other side doesn't fit
if (total_left <= total_right || !right_fits) && left_fits {
// add left tab
let tab = tabs_before_active.pop().unwrap();
Expand Down
2 changes: 1 addition & 1 deletion docs/TERMINOLOGY.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Part of the ANSI/VT specification that includes instructions for the terminal em
Part of the ANSI/VT specification that includes instructions for the underlying operating system (eg. change window title).

## pty
A pty (pseudoterminal) is a character device that emulates a traditional terminal. It is a pair of processes (traditionally given culturally incensitive names, here they will be refered to as primary/secondary).
A pty (pseudoterminal) is a character device that emulates a traditional terminal. It is a pair of processes (traditionally given culturally incensitive names, here they will be referred to as primary/secondary).

The primary part is the part connected to the terminal emulator. The emulator listens to this part of the channel, reads instructions from it that it uses in order to draw characters on the screen.
The secondary part is used by the program running inside the terminal (eg. the shell) in order to send those instructions.
Expand Down
2 changes: 1 addition & 1 deletion zellij-client/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ pub fn start_client(
let send_client_instructions = send_client_instructions.clone();
let os_input = os_input.clone();
Box::new(move |info| {
error!("Panic occured in client:\n{:?}", info);
error!("Panic occurred in client:\n{:?}", info);
if let Ok(()) = os_input.unset_raw_mode(0) {
handle_panic(info, &send_client_instructions);
}
Expand Down
2 changes: 1 addition & 1 deletion zellij-server/src/logging_pipe.rs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ impl Write for LoggingPipe {
if self.buffer.len() + buf.len() > ZELLIJ_MAX_PIPE_BUFFER_SIZE {
let error_msg =
"Exceeded log buffer size. Make sure that your plugin calls flush on stderr on \
valid UTF-8 symbol boundary. Aditionally, make sure that your log message contains \
valid UTF-8 symbol boundary. Additionally, make sure that your log message contains \
endline \\n symbol.";
error!("{}: {}", self.plugin_name, error_msg);
self.buffer.clear();
Expand Down
2 changes: 1 addition & 1 deletion zellij-server/src/os_input_output.rs
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ pub trait ServerOsApi: Send + Sync {
/// Sets the size of the terminal associated to file descriptor `fd`.
fn set_terminal_size_using_fd(&self, fd: RawFd, cols: u16, rows: u16);
/// Spawn a new terminal, with a terminal action. The returned tuple contains the master file
/// descriptor of the forked psuedo terminal and a [ChildId] struct containing process id's for
/// descriptor of the forked pseudo terminal and a [ChildId] struct containing process id's for
/// the forked child process.
fn spawn_terminal(
&self,
Expand Down
2 changes: 1 addition & 1 deletion zellij-server/src/panes/grid.rs
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ impl Grid {
}
cursor_canonical_line_index
}
// TODO: merge these two funtions
// TODO: merge these two functions
fn cursor_index_in_canonical_line(&self) -> usize {
let mut cursor_canonical_line_index = 0;
let mut cursor_index_in_canonical_line = 0;
Expand Down
12 changes: 6 additions & 6 deletions zellij-server/src/tab/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1144,7 +1144,7 @@ impl Tab {
.floating_panes
.resize_active_pane_left(client_id, &mut self.os_api);
if successfully_resized {
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" incase of a decrease
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" in case of a decrease
}
} else {
self.tiled_panes.resize_active_pane_left(client_id);
Expand All @@ -1156,7 +1156,7 @@ impl Tab {
.floating_panes
.resize_active_pane_right(client_id, &mut self.os_api);
if successfully_resized {
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" incase of a decrease
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" in case of a decrease
}
} else {
self.tiled_panes.resize_active_pane_right(client_id);
Expand All @@ -1168,7 +1168,7 @@ impl Tab {
.floating_panes
.resize_active_pane_down(client_id, &mut self.os_api);
if successfully_resized {
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" incase of a decrease
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" in case of a decrease
}
} else {
self.tiled_panes.resize_active_pane_down(client_id);
Expand All @@ -1180,7 +1180,7 @@ impl Tab {
.floating_panes
.resize_active_pane_up(client_id, &mut self.os_api);
if successfully_resized {
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" incase of a decrease
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" in case of a decrease
}
} else {
self.tiled_panes.resize_active_pane_up(client_id);
Expand All @@ -1192,7 +1192,7 @@ impl Tab {
.floating_panes
.resize_active_pane_increase(client_id, &mut self.os_api);
if successfully_resized {
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" incase of a decrease
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" in case of a decrease
}
} else {
self.tiled_panes.resize_active_pane_increase(client_id);
Expand All @@ -1204,7 +1204,7 @@ impl Tab {
.floating_panes
.resize_active_pane_decrease(client_id, &mut self.os_api);
if successfully_resized {
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" incase of a decrease
self.set_force_render(); // we force render here to make sure the panes under the floating pane render and don't leave "garbage" in case of a decrease
}
} else {
self.tiled_panes.resize_active_pane_decrease(client_id);
Expand Down
2 changes: 1 addition & 1 deletion zellij-utils/src/envs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pub struct EnvironmentVariablesFromYaml {
}

impl EnvironmentVariablesFromYaml {
/// Merges two structs, keys from `other` supercede keys from `self`
/// Merges two structs, keys from `other` supersede keys from `self`
pub fn merge(&self, other: Self) -> Self {
let mut env = self.clone();
env.env.extend(other.env);
Expand Down
2 changes: 1 addition & 1 deletion zellij-utils/src/input/actions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ pub enum Action {
GoToTab(u32),
ToggleTab,
TabNameInput(Vec<u8>),
/// Run speficied command in new pane.
/// Run specified command in new pane.
Run(RunCommandAction),
/// Detach session and exit
Detach,
Expand Down
2 changes: 1 addition & 1 deletion zellij-utils/src/input/layout.rs
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ pub struct LayoutTemplate {
}

impl LayoutTemplate {
// Insert an optional `[TabLayout]` at the correct postion
// Insert an optional `[TabLayout]` at the correct position
pub fn insert_tab_layout(mut self, tab_layout: Option<TabLayout>) -> Self {
if self.body {
return tab_layout.unwrap_or_default().into();
Expand Down
4 changes: 2 additions & 2 deletions zellij-utils/src/input/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ impl Options {
}

/// Merges two [`Options`] structs, a `Some` in `other`
/// will supercede a `Some` in `self`
/// will supersede a `Some` in `self`
// TODO: Maybe a good candidate for a macro?
pub fn merge(&self, other: Options) -> Options {
let mouse_mode = other.mouse_mode.or(self.mouse_mode);
Expand Down Expand Up @@ -163,7 +163,7 @@ impl Options {
}

/// Merges two [`Options`] structs,
/// - `Some` in `other` will supercede a `Some` in `self`
/// - `Some` in `other` will supersede a `Some` in `self`
/// - `Some(bool)` in `other` will toggle a `Some(bool)` in `self`
// TODO: Maybe a good candidate for a macro?
pub fn merge_from_cli(&self, other: Options) -> Options {
Expand Down
4 changes: 2 additions & 2 deletions zellij-utils/src/input/plugins.rs
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ pub struct PluginConfig {
impl PluginConfig {
/// Resolve wasm plugin bytes for the plugin path and given plugin directory. Attempts to first
/// resolve the plugin path as an absolute path, then adds a ".wasm" extension to the path and
/// resolves that, finally we use the plugin directoy joined with the path with an appended
/// resolves that, finally we use the plugin directory joined with the path with an appended
/// ".wasm" extension. So if our path is "tab-bar" and the given plugin dir is
/// "/home/bob/.zellij/plugins" the lookup chain will be this:
///
Expand Down Expand Up @@ -156,7 +156,7 @@ impl PluginConfig {
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum PluginType {
// TODO: A plugin with output thats cloned across every pane in a tab, or across the entire
// TODO: A plugin with output that's cloned across every pane in a tab, or across the entire
// application might be useful
// Tab
// Static
Expand Down

0 comments on commit 16b53aa

Please sign in to comment.