Skip to content

Commit

Permalink
Fix docs typos (#284)
Browse files Browse the repository at this point in the history
* s/east/easy/

* s/differnt/different/

* s/there/their/

* s/the the/the/

* s/behviour/behaviour/

* s/inital/initial/

* s/positions/positioned/

---------

Co-authored-by: adder32 <adder32@users.noreply.github.com>
  • Loading branch information
adder32 and adder32 committed Nov 20, 2023
1 parent b212aa2 commit 3e2a637
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion src/core/bindings.rs
Expand Up @@ -17,7 +17,7 @@ use tracing::trace;
///
/// This is done in a form that we can load in and convert back to key
/// codes. This lets the user define key bindings in the way that they
/// would expect while also ensuring that it is east to debug any odd
/// would expect while also ensuring that it is easy to debug any odd
/// issues with bindings by referring the user to the xmodmap output.
///
/// # Panics
Expand Down
12 changes: 6 additions & 6 deletions src/core/hooks.rs
Expand Up @@ -2,10 +2,10 @@
//!
//! ## Hook points
//!
//! Penrose offers several differnt hook points where you are able to provide custom
//! Penrose offers several different hook points where you are able to provide custom
//! logic to execute as part of the main WindowManager event loop. Unlike logic you
//! add as KeyEventHandlers, hooks will be run automatically by Penrose as and when
//! the conditions for there execution arises. Each hook point requires a specific
//! the conditions for their execution arises. Each hook point requires a specific
//! trait to be implemented and in the simplest case, functions with the correct
//! type signature can be used directly (though you will likely want to implement
//! traits directly if you are looking for more control over how your hook logic is
Expand All @@ -16,7 +16,7 @@
//!
//! Startup hooks are implemented using the [`StateHook`] trait, allowing you access
//! to the pure WindowManager internal [`State`] and the [`XConn`] in order to run
//! any set up code you need which requires the the bindings to already have been
//! any set up code you need which requires the bindings to already have been
//! grabbed but before any existing clients are parsed and managed by the WindowManager.
//!
//! > **NOTE**: Startup hooks are run to completion before entering the main event loop.
Expand All @@ -31,7 +31,7 @@
//!
//! This hook returns a `bool` indicating whether or not the default event handling logic
//! needs to run after your hook has finished: to run the default handling you should return
//! `true`, to skip the handling (and prevent the normal behviour for such an event) you
//! `true`, to skip the handling (and prevent the normal behaviour for such an event) you
//! can return `false`.
//!
//! > **NOTE**: Be careful about disabling default event handling! If you drop events
Expand All @@ -52,15 +52,15 @@
//! > **NOTE**: ManageHooks should _not_ directly trigger a refresh of the X state!
//! > They are already called by the XConn immediately before refreshing so all
//! > triggering a refresh directly will do is run the refresh twice: once with
//! > the inital state of the client before your hook was applied and once after.
//! > the initial state of the client before your hook was applied and once after.
//!
//! ### Layout Hooks
//!
//! Finally we have [`LayoutHook`]s which operate a little differently, in that they have
//! two methods to implement. Layout hooks are run _around_ whatever [Layout][1] is active
//! for the focused workspace, allowing you to modify the screen dimensions available for the
//! layout algorithm before it runs and editing the list of window positions it generates
//! before they are applied. This lets you do things like prevent windows being positions on
//! before they are applied. This lets you do things like prevent windows being positioned on
//! certain parts of the screen, or injecting/removing additional window positions.
//!
//! This is somewhat similar to the [`LayoutTransformer`] trait which is a wrapper around a
Expand Down

0 comments on commit 3e2a637

Please sign in to comment.