Add documentation to flags

1 files changed, 28 insertions, 32 deletions

diff --git a/init.el b/init.el
index 7a2ea12..224113e 100644
--- a/init.el
+++ b/init.el
@@ -27,8 +27,10 @@
 (define-key ymh-map (kbd "C-p") #'org-previous-link)
 (define-key ymh-map (kbd "C-n") #'org-next-link)
 
-(defvar ymh/org-base-dir "~/Dropbox/org")
-(defvar ymh/bib-base-dir "~/Dropbox/bibliography")
+(defvar ymh/org-base-dir "~/Dropbox/org"
+  "Contains the base directory for Org files.")
+(defvar ymh/bib-base-dir "~/Dropbox/bibliography"
+  "Contains the base directory for the bibliography related files.")
 
 (defun ymh/expand-org-file (file)
   "Expand file name relative to `ymh/org-base-dir'."
@@ -45,10 +47,12 @@
 (set-register ?c (cons 'file (ymh/expand-org-file
                               (format-time-string "%Y-%m.org"))))
 
-(when (eq system-type 'darwin) (customize-set-variable 'native-comp-driver-options '("-Wl,-w")))
+(defvar ymh/emacs-29-p (version<= "29" emacs-version)
+  "Checks if the current emacs version is 29 or not.")
+(defvar ymh/macos-p (eq system-type 'darwin)
+  "Checks if the current operating system is MacOS.")
 
-(defvar emacs-29-p)
-(setq emacs-29-p (version<= "29" emacs-version))
+(when ymh/macos-p (customize-set-variable 'native-comp-driver-options '("-Wl,-w")))
 
 (require 'package)
 (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t)
@@ -79,7 +83,7 @@
   (setq-default bidi-paragraph-direction 'left-to-right)
   (if (version<= "27.1" emacs-version)
       (setq bidi-inhibit-bpa t))
-  ;; Set up dictionaries
+
   (setq read-extended-command-predicate
         #'command-completion-default-include-p)
 
@@ -90,17 +94,16 @@
   (if (not (file-exists-p --backup-directory))
       (make-directory --backup-directory t))
   (setq backup-directory-alist `(("." . ,--backup-directory)))
-  (setq make-backup-files t               ; backup of a file the first time it is saved.
-        backup-by-copying t               ; don't clobber symlinks
-        version-control t                 ; version numbers for backup files
-        delete-old-versions t             ; delete excess backup files silently
-        delete-by-moving-to-trash t
-        kept-old-versions 6               ; oldest versions to keep when a new numbered backup is made (default: 2)
-        kept-new-versions 9               ; newest versions to keep when a new numbered backup is made (default: 2)
-        auto-save-default t               ; auto-save every buffer that visits a file
-        auto-save-timeout 20              ; number of seconds idle time before auto-save (default: 30)
-        auto-save-interval 200            ; number of keystrokes between auto-saves (default: 300)
-        )
+  (setq make-backup-files t)
+  (setq backup-by-copying t)
+  (setq version-control t)
+  (setq delete-old-versions t)
+  (setq delete-by-moving-to-trash t)
+  (setq kept-old-versions 6)
+  (setq kept-new-versions 9)
+  (setq auto-save-default t)
+  (setq auto-save-timeout 20)
+  (setq auto-save-interval 200)
 
   (setq vc-follow-symlinks t)
 
@@ -121,7 +124,7 @@
 
   (setq line-number-display-limit 2000000)
 
-  (unless (eq system-type 'darwin)
+  (unless ymh/macos-p
     (setq default-frame-alist '((undecorated . t)
                                 (drag-internal-border . 1)
                                 (internal-border-width . 5))))
@@ -131,7 +134,7 @@
 
   (add-hook 'text-mode-hook #'visual-line-mode)
   :config
-  (unless (string= system-type "darwin")
+  (unless ymh/macos-p
     (menu-bar-mode -1))
   (tool-bar-mode -1)
   (scroll-bar-mode -1)
@@ -153,7 +156,7 @@
          auto-mode-alist))
 
   ;; Mac configuration
-  (when (eq system-type 'darwin)
+  (when ymh/macos-p
     (setq mac-right-option-modifier 'hyper)
     (setq mac-command-modifier 'meta)
     (setq mac-option-modifier 'super)
@@ -509,7 +512,7 @@ https://yannherklotz.com"))
   :after org
   :init
   (unless (package-installed-p 'org-zettelkasten)
-    (if emacs-29-p
+    (if ymh/emacs-29-p
         (package-vc-install
          '(org-zettelkasten
            . (:url "https://git.sr.ht/~ymherklotz/org-zettelkasten")))
@@ -589,7 +592,7 @@ https://yannherklotz.com"))
   (setq message-sendmail-envelope-from 'header)
   (setq mail-envelope-from 'header)
   :config
-  (if (eq system-type 'darwin)
+  (if ymh/macos-p
       (setq sendmail-program "/usr/local/bin/msmtp")
     (setq sendmail-program "/usr/bin/msmtp")))
 
@@ -670,7 +673,7 @@ https://yannherklotz.com"))
   :config
   (add-to-list 'ebib-notes-template-specifiers '(?k . ymh/ebib-create-identifier))
   (add-to-list 'ebib-file-search-dirs (ymh/expand-bib-file "papers"))
-  (if (eq system-type 'darwin)
+  (if ymh/macos-p
       (add-to-list 'ebib-file-associations '("pdf" . "open"))
     (add-to-list 'ebib-file-associations '("pdf" . nil)))
   (add-to-list 'ebib-citation-commands '(org-mode (("ref" "[cite:@%(%K%,)]"))))
@@ -721,13 +724,6 @@ https://yannherklotz.com"))
   :config
   (setq geiser-chicken-binary "chicken-csi"))
 
-;;(use-package bufferlo
-;;  :ensure (:host github :repo "florommel/bufferlo")
-;;  :defer nil
-;;  :bind (("C-x b" . bufferlo-switch-to-buffer))
-;;  :config
-;;  (bufferlo-mode 1))
-
 (use-package haskell-mode
   :ensure t)
 
@@ -761,7 +757,7 @@ https://yannherklotz.com"))
   :hook (coq-mode . alectryon-mode)
   :delight alectryon-mode
   :config
-  (when (eq system-type 'darwin)
+  (when ymh/macos-p
     (setq alectryon-executable "/nix/store/bvlk3hyrjdgl0sg93rrdr2z71hgza0m9-python3.9-alectryon-1.4.0/bin/alectryon"))
   (defun ymh/alectryon-preview ()
     "Display an HTML preview of the current buffer."
@@ -820,7 +816,7 @@ https://yannherklotz.com"))
   (global-hungry-delete-mode))
 
 (use-package eglot
-  :if (not emacs-29-p)
+  :if (not ymh/emacs-29-p)
   :ensure t)
 
 (use-package eglot