docs: fix typos (#1481)

This commit is contained in:
Kian-Meng Ang 2022-06-10 22:37:55 +08:00 committed by GitHub
parent edac2eb5a9
commit 16b53aa52f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 22 additions and 22 deletions

View File

@ -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: 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: 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: 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: 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) * 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) * Add: infrastructure to show distinct tips in the `status-bar` plugin (https://github.com/zellij-org/zellij/pull/926)
@ -183,7 +183,7 @@ that loads the `compact-bar`. (https://github.com/zellij-org/zellij/pull/1450)
## [0.21.0] - 2021-11-29 ## [0.21.0] - 2021-11-29
* Add: initial preparations for overlay's (https://github.com/zellij-org/zellij/pull/871) * 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: 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) * 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) * Fix: handling and overwriting options through the cli (https://github.com/zellij-org/zellij/pull/859)

View File

@ -68,7 +68,7 @@ fn populate_tabs_in_tab_line(
let left_fits = size_by_adding_left <= cols; let left_fits = size_by_adding_left <= cols;
let right_fits = size_by_adding_right <= cols; let right_fits = size_by_adding_right <= cols;
// active tab is kept in the middle by adding to the side that // 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 { if (total_left <= total_right || !right_fits) && left_fits {
// add left tab // add left tab
let tab = tabs_before_active.pop().unwrap(); let tab = tabs_before_active.pop().unwrap();

View File

@ -68,7 +68,7 @@ fn populate_tabs_in_tab_line(
let left_fits = size_by_adding_left <= cols; let left_fits = size_by_adding_left <= cols;
let right_fits = size_by_adding_right <= cols; let right_fits = size_by_adding_right <= cols;
// active tab is kept in the middle by adding to the side that // 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 { if (total_left <= total_right || !right_fits) && left_fits {
// add left tab // add left tab
let tab = tabs_before_active.pop().unwrap(); let tab = tabs_before_active.pop().unwrap();

View File

@ -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). Part of the ANSI/VT specification that includes instructions for the underlying operating system (eg. change window title).
## pty ## 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 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. The secondary part is used by the program running inside the terminal (eg. the shell) in order to send those instructions.

View File

@ -202,7 +202,7 @@ pub fn start_client(
let send_client_instructions = send_client_instructions.clone(); let send_client_instructions = send_client_instructions.clone();
let os_input = os_input.clone(); let os_input = os_input.clone();
Box::new(move |info| { 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) { if let Ok(()) = os_input.unset_raw_mode(0) {
handle_panic(info, &send_client_instructions); handle_panic(info, &send_client_instructions);
} }

View File

@ -54,7 +54,7 @@ impl Write for LoggingPipe {
if self.buffer.len() + buf.len() > ZELLIJ_MAX_PIPE_BUFFER_SIZE { if self.buffer.len() + buf.len() > ZELLIJ_MAX_PIPE_BUFFER_SIZE {
let error_msg = let error_msg =
"Exceeded log buffer size. Make sure that your plugin calls flush on stderr on \ "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."; endline \\n symbol.";
error!("{}: {}", self.plugin_name, error_msg); error!("{}: {}", self.plugin_name, error_msg);
self.buffer.clear(); self.buffer.clear();

View File

@ -271,7 +271,7 @@ pub trait ServerOsApi: Send + Sync {
/// Sets the size of the terminal associated to file descriptor `fd`. /// Sets the size of the terminal associated to file descriptor `fd`.
fn set_terminal_size_using_fd(&self, fd: RawFd, cols: u16, rows: u16); 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 /// 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. /// the forked child process.
fn spawn_terminal( fn spawn_terminal(
&self, &self,

View File

@ -495,7 +495,7 @@ impl Grid {
} }
cursor_canonical_line_index cursor_canonical_line_index
} }
// TODO: merge these two funtions // TODO: merge these two functions
fn cursor_index_in_canonical_line(&self) -> usize { fn cursor_index_in_canonical_line(&self) -> usize {
let mut cursor_canonical_line_index = 0; let mut cursor_canonical_line_index = 0;
let mut cursor_index_in_canonical_line = 0; let mut cursor_index_in_canonical_line = 0;

View File

@ -1144,7 +1144,7 @@ impl Tab {
.floating_panes .floating_panes
.resize_active_pane_left(client_id, &mut self.os_api); .resize_active_pane_left(client_id, &mut self.os_api);
if successfully_resized { 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 { } else {
self.tiled_panes.resize_active_pane_left(client_id); self.tiled_panes.resize_active_pane_left(client_id);
@ -1156,7 +1156,7 @@ impl Tab {
.floating_panes .floating_panes
.resize_active_pane_right(client_id, &mut self.os_api); .resize_active_pane_right(client_id, &mut self.os_api);
if successfully_resized { 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 { } else {
self.tiled_panes.resize_active_pane_right(client_id); self.tiled_panes.resize_active_pane_right(client_id);
@ -1168,7 +1168,7 @@ impl Tab {
.floating_panes .floating_panes
.resize_active_pane_down(client_id, &mut self.os_api); .resize_active_pane_down(client_id, &mut self.os_api);
if successfully_resized { 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 { } else {
self.tiled_panes.resize_active_pane_down(client_id); self.tiled_panes.resize_active_pane_down(client_id);
@ -1180,7 +1180,7 @@ impl Tab {
.floating_panes .floating_panes
.resize_active_pane_up(client_id, &mut self.os_api); .resize_active_pane_up(client_id, &mut self.os_api);
if successfully_resized { 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 { } else {
self.tiled_panes.resize_active_pane_up(client_id); self.tiled_panes.resize_active_pane_up(client_id);
@ -1192,7 +1192,7 @@ impl Tab {
.floating_panes .floating_panes
.resize_active_pane_increase(client_id, &mut self.os_api); .resize_active_pane_increase(client_id, &mut self.os_api);
if successfully_resized { 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 { } else {
self.tiled_panes.resize_active_pane_increase(client_id); self.tiled_panes.resize_active_pane_increase(client_id);
@ -1204,7 +1204,7 @@ impl Tab {
.floating_panes .floating_panes
.resize_active_pane_decrease(client_id, &mut self.os_api); .resize_active_pane_decrease(client_id, &mut self.os_api);
if successfully_resized { 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 { } else {
self.tiled_panes.resize_active_pane_decrease(client_id); self.tiled_panes.resize_active_pane_decrease(client_id);

View File

@ -36,7 +36,7 @@ pub struct EnvironmentVariablesFromYaml {
} }
impl 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 { pub fn merge(&self, other: Self) -> Self {
let mut env = self.clone(); let mut env = self.clone();
env.env.extend(other.env); env.env.extend(other.env);

View File

@ -104,7 +104,7 @@ pub enum Action {
GoToTab(u32), GoToTab(u32),
ToggleTab, ToggleTab,
TabNameInput(Vec<u8>), TabNameInput(Vec<u8>),
/// Run speficied command in new pane. /// Run specified command in new pane.
Run(RunCommandAction), Run(RunCommandAction),
/// Detach session and exit /// Detach session and exit
Detach, Detach,

View File

@ -453,7 +453,7 @@ pub struct LayoutTemplate {
} }
impl 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 { pub fn insert_tab_layout(mut self, tab_layout: Option<TabLayout>) -> Self {
if self.body { if self.body {
return tab_layout.unwrap_or_default().into(); return tab_layout.unwrap_or_default().into();

View File

@ -122,7 +122,7 @@ impl Options {
} }
/// Merges two [`Options`] structs, a `Some` in `other` /// 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? // TODO: Maybe a good candidate for a macro?
pub fn merge(&self, other: Options) -> Options { pub fn merge(&self, other: Options) -> Options {
let mouse_mode = other.mouse_mode.or(self.mouse_mode); let mouse_mode = other.mouse_mode.or(self.mouse_mode);
@ -163,7 +163,7 @@ impl Options {
} }
/// Merges two [`Options`] structs, /// 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` /// - `Some(bool)` in `other` will toggle a `Some(bool)` in `self`
// TODO: Maybe a good candidate for a macro? // TODO: Maybe a good candidate for a macro?
pub fn merge_from_cli(&self, other: Options) -> Options { pub fn merge_from_cli(&self, other: Options) -> Options {

View File

@ -124,7 +124,7 @@ pub struct PluginConfig {
impl PluginConfig { impl PluginConfig {
/// Resolve wasm plugin bytes for the plugin path and given plugin directory. Attempts to first /// 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 /// 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 /// ".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: /// "/home/bob/.zellij/plugins" the lookup chain will be this:
/// ///
@ -156,7 +156,7 @@ impl PluginConfig {
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)] #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")] #[serde(rename_all = "kebab-case")]
pub enum PluginType { 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 // application might be useful
// Tab // Tab
// Static // Static