From d5a0d68c0ba6090213d11f87d2803ca5996577a2 Mon Sep 17 00:00:00 2001 From: Almarhoon Ibraheem Date: Wed, 26 Jun 2024 00:02:30 +0300 Subject: [PATCH] fix documentation --- modules/auto-reload.scm | 12 ++++++++++-- modules/workspace-grid.scm | 8 ++++---- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/modules/auto-reload.scm b/modules/auto-reload.scm index 4e4c45c..b2b015e 100755 --- a/modules/auto-reload.scm +++ b/modules/auto-reload.scm @@ -1,5 +1,13 @@ -;; use example: -;; NOTE: use full path for your home, don't use tilde (~) +;; The auto-reload module is designed to automatically reload Sway +;; configuration when changes are detected in specified directories. +;; This module leverages the Sway IPC protocol for reloading and uses +;; inotify for monitoring file system events. The key functions are: +;; auto-reload-configure: Configures the directories to watch for changes. +;; auto-reload-init: Initiates the monitoring of the specified directories +;; and reloads the Sway configuration upon detecting changes. + +;; Here's an example of how to use this module: +;; NOTE: use the full path for your home, don't use tilde (~) ;; (auto-reload-configure #:directories '("/home/ebeem/.config/sway/")) ;; (auto-reload-init) diff --git a/modules/workspace-grid.scm b/modules/workspace-grid.scm index 9838f1f..9e8e6b6 100755 --- a/modules/workspace-grid.scm +++ b/modules/workspace-grid.scm @@ -1,9 +1,9 @@ ;; use example: -;; (workspace-grid-configure #:rows 2 #:columns -;; '(("ws-o1-1" "ws-o1-2" "ws-o1-3" "ws-o1-3") -;; ("ws-o2-1" "ws-o2-2" "ws-o2-3" "ws-o2-3") -;; ("ws-o3-1" "ws-o3-2" "ws-o3-3" "ws-o3-3"))) +;; (workspace-grid-configure #:rows 2 #:columns 2 #:workspaces +;; '(("ws-o1-1" "ws-o1-2" "ws-o1-3" "ws-o1-4") +;; ("ws-o2-1" "ws-o2-2" "ws-o2-3" "ws-o2-4") +;; ("ws-o3-1" "ws-o3-2" "ws-o3-3" "ws-o3-4"))) ;; (workspace-grid-init) (define-module (modules workspace-grid)