From 6d3caf4cd0cd168135e4ef7f1838914a5b70b7da Mon Sep 17 00:00:00 2001 From: SqrtMinusOne Date: Fri, 24 Dec 2021 22:26:49 +0300 Subject: [PATCH] docs: better docs --- perspective-exwm.el | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/perspective-exwm.el b/perspective-exwm.el index 5ecc6c8..132bb61 100644 --- a/perspective-exwm.el +++ b/perspective-exwm.el @@ -26,7 +26,23 @@ ;;; Commentary: -;; TODO +;; A couple of tricks and fixes to make using EXWM and perspective.el +;; a better experience. +;; +;; Most importantly, this package provides `perspective-exwm-mode', +;; which fixes certain annoying issues between the two packages. Take +;; a look at its docstring for more info. +;; +;; Other useful functions are: +;; - `perspective-exwm-cycle-exwm-buffers-backward' and +;; `perspective-exwm-cycle-exwm-buffers-backward' +;; - `perspective-exwm-switch-perspective' +;; - `perspective-exwm-copy-to-workspace' and +;; `perspective-exwm-move-to-workspace' +;; +;; Finally, take a look at the package README at +;; for more +;; information. ;;; Code: (require 'burly) @@ -376,8 +392,8 @@ The mode does a couple of things: anyway. - fixes a bug with running `persp-set-buffer' on an EXWM buffer that was moved between workspaces by advising `persp-buffer-in-other-p'. - - fixes a bug when occasionally `persp-set-buffer' copied all the - perspectives from another workspaces to the current one + - fixes a bug with `persp-set-buffer' copying all the + perspectives from other workspaces to the current one - adjusts the name of the inital perspective in the new workspace. It tries to get the name from the `perspective-exwm-override-initial-name' variable and falls back to