From 7d20056c307855dba2dff37a91410a594309bb85 Mon Sep 17 00:00:00 2001 From: Levi Neely <141506390+lneely@users.noreply.github.com> Date: Sun, 15 Sep 2024 19:30:18 +0200 Subject: [PATCH] docs --- emacs/feature/feature-base.el | 1 - emacs/feature/feature-better-minibuf.el | 5 +++-- emacs/feature/feature-completion.el | 6 +++--- emacs/feature/feature-consult.el | 6 ++++-- emacs/feature/feature-dev.el | 5 +++-- emacs/feature/feature-diagram.el | 2 +- emacs/feature/feature-feeds.el | 5 ++--- emacs/feature/feature-project.el | 5 +++-- emacs/feature/feature-vcs.el | 2 +- emacs/init.el | 1 + emacs/lisp/org-ai | 1 - emacs/module/module-alioth.el | 1 + emacs/module/module-apitest.el | 8 ++++++-- emacs/module/module-async.el | 6 ++++-- emacs/module/module-avy.el | 5 +++-- emacs/module/module-browser.el | 8 ++++++-- emacs/module/module-consult-projectile.el | 4 +++- emacs/module/module-consult.el | 2 ++ emacs/module/module-ctags.el | 7 +++++-- emacs/module/module-denote-index.el | 5 +++-- emacs/module/module-denote-multidir.el | 1 + emacs/module/module-denote.el | 5 +++-- emacs/module/module-detached.el | 2 ++ emacs/module/module-dired.el | 4 +++- emacs/module/module-embark.el | 8 ++++++-- emacs/module/module-eshell.el | 3 ++- emacs/module/module-eyecandy.el | 7 +++++-- emacs/module/module-golang-playground.el | 7 +++++-- emacs/module/module-golang.el | 7 +++++-- emacs/module/module-graphviz.el | 7 +++++-- emacs/module/module-json.el | 7 +++++-- emacs/module/module-kotlin.el | 8 ++++++-- emacs/module/module-llm.el | 6 +++++- emacs/module/module-lmtf.el | 7 +++++-- emacs/module/module-magit.el | 2 ++ emacs/module/module-multi-cursor.el | 4 +++- emacs/module/module-orderless.el | 7 +++++-- emacs/module/module-org-denote.el | 4 +++- emacs/module/module-org.el | 4 +++- emacs/module/module-plantuml.el | 7 +++++-- emacs/module/module-projectile.el | 4 +++- emacs/module/module-protobuf.el | 7 +++++-- emacs/module/module-python.el | 7 +++++-- emacs/module/module-rego.el | 7 +++++-- emacs/module/module-rss.el | 5 +++-- emacs/module/module-scratch.el | 5 +++++ emacs/module/module-snippets.el | 8 ++++++-- emacs/module/module-syntax.el | 10 +++++++--- emacs/module/module-vertico.el | 5 +++-- emacs/module/module-web.el | 8 ++++++-- emacs/module/module-which-key.el | 8 ++++++-- emacs/module/module-yaml.el | 7 +++++-- 52 files changed, 192 insertions(+), 81 deletions(-) delete mode 160000 emacs/lisp/org-ai diff --git a/emacs/feature/feature-base.el b/emacs/feature/feature-base.el index 2ee0c8a..edd96b3 100644 --- a/emacs/feature/feature-base.el +++ b/emacs/feature/feature-base.el @@ -18,7 +18,6 @@ (require 'module-scratch) (require 'module-eyecandy) (require 'module-avy) -(require 'module-snippets) (require 'module-browser) diff --git a/emacs/feature/feature-better-minibuf.el b/emacs/feature/feature-better-minibuf.el index a8b49e7..6b6cba8 100644 --- a/emacs/feature/feature-better-minibuf.el +++ b/emacs/feature/feature-better-minibuf.el @@ -1,8 +1,9 @@ -;;; feature-better-minibuf.el -- knowledge management +;;; feature-better-minibuf.el -- better minibuffers ;;; ;;; Commentary: ;;; -;;; Loads modules related to knowledge management. +;;; Emacs minibuffer kind of sucks by default. Improves and extends +;;; Emacs minibuffer functionality. ;;; ;;; Code: diff --git a/emacs/feature/feature-completion.el b/emacs/feature/feature-completion.el index 97036e4..7a42936 100644 --- a/emacs/feature/feature-completion.el +++ b/emacs/feature/feature-completion.el @@ -1,13 +1,13 @@ -;;; feature-completion.el -- knowledge management +;;; feature-completion.el -- automatic completion ;;; ;;; Commentary: ;;; -;;; Loads modules related to knowledge management. +;;; Automatic completion modules for lazy people. ;;; ;;; Code: (require 'module-orderless) - +(require 'module-snippets) (provide 'feature-completion) diff --git a/emacs/feature/feature-consult.el b/emacs/feature/feature-consult.el index 1dfa6bd..ed02a7f 100644 --- a/emacs/feature/feature-consult.el +++ b/emacs/feature/feature-consult.el @@ -1,8 +1,10 @@ -;;; feature-consult.el -- knowledge management +;;; feature-consult.el -- consult ;;; ;;; Commentary: ;;; -;;; Loads modules related to knowledge management. +;;; Consult provides enhanced search and navigation functionality for +;;; Emacs. It is broad enough in scope, and has enough extensions, to +;;; warrant its own feature. ;;; ;;; Code: diff --git a/emacs/feature/feature-dev.el b/emacs/feature/feature-dev.el index 7ce3ddb..0d75a31 100644 --- a/emacs/feature/feature-dev.el +++ b/emacs/feature/feature-dev.el @@ -1,8 +1,9 @@ -;;; feature-dev.el -- knowledge management +;;; feature-dev.el -- coding stuff ;;; ;;; Commentary: ;;; -;;; Loads modules related to knowledge management. +;;; Enables support for development related packages, such as +;;; programming language major modes. ;;; ;;; Code: diff --git a/emacs/feature/feature-diagram.el b/emacs/feature/feature-diagram.el index b457f1b..b9745d4 100644 --- a/emacs/feature/feature-diagram.el +++ b/emacs/feature/feature-diagram.el @@ -2,7 +2,7 @@ ;;; ;;; Commentary: ;;; -;;; Loads modules related to diagramming. +;;; Diagramming in plain text! ;;; ;;; Code: diff --git a/emacs/feature/feature-feeds.el b/emacs/feature/feature-feeds.el index a7ba7f1..f3ff2a2 100644 --- a/emacs/feature/feature-feeds.el +++ b/emacs/feature/feature-feeds.el @@ -1,13 +1,12 @@ -;;; feature-feeds.el -- knowledge management +;;; feature-feeds.el -- news feeds ;;; ;;; Commentary: ;;; -;;; Loads modules related to knowledge management. +;;; Read news feeds from Emacs, because browsing the web sucks. ;;; ;;; Code: (require 'module-rss) (provide 'feature-feeds) - ;;; feature-feeds.el ends here. diff --git a/emacs/feature/feature-project.el b/emacs/feature/feature-project.el index bd1c5cf..ac82247 100644 --- a/emacs/feature/feature-project.el +++ b/emacs/feature/feature-project.el @@ -1,8 +1,9 @@ -;;; feature-project.el -- knowledge management +;;; feature-project.el -- projects ;;; ;;; Commentary: ;;; -;;; Loads modules related to knowledge management. +;;; Provides a definition of a "project" to Emacs, and facilities for +;;; working with them. ;;; ;;; Code: diff --git a/emacs/feature/feature-vcs.el b/emacs/feature/feature-vcs.el index 4bec111..fda4a2f 100644 --- a/emacs/feature/feature-vcs.el +++ b/emacs/feature/feature-vcs.el @@ -2,7 +2,7 @@ ;;; ;;; Commentary: ;;; -;;; Loads modules related to version control. +;;; Provides version control integration. ;;; ;;; Code: diff --git a/emacs/init.el b/emacs/init.el index 35ed8b7..64d366c 100644 --- a/emacs/init.el +++ b/emacs/init.el @@ -37,4 +37,5 @@ (load-theme 'misterioso) +(provide 'init) ;;; init.el ends here diff --git a/emacs/lisp/org-ai b/emacs/lisp/org-ai deleted file mode 160000 index 02a4325..0000000 --- a/emacs/lisp/org-ai +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 02a43259e357846372672b58ba9416093493b3fb diff --git a/emacs/module/module-alioth.el b/emacs/module/module-alioth.el index 41927a3..de752c3 100644 --- a/emacs/module/module-alioth.el +++ b/emacs/module/module-alioth.el @@ -1,6 +1,7 @@ ;;; module-alioth.el --- alioth automount -*- lexical-binding: t; -*- ;;; ;;; Commentary: +;;; ;;; Automount alioth on demand. ;;; ;;; Code: diff --git a/emacs/module/module-apitest.el b/emacs/module/module-apitest.el index 82c5e67..5bcdc5e 100644 --- a/emacs/module/module-apitest.el +++ b/emacs/module/module-apitest.el @@ -1,5 +1,9 @@ -;;; module-apitest.el --- Brief description -*- lexical-binding: t; -*- - +;;; module-apitest.el --- api testing shit -*- lexical-binding: t; -*- +;;; +;;; Commentary: +;;; +;;; Postman is bullshit. Do your API testing in Emacs. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-async.el b/emacs/module/module-async.el index 2a3fd1b..35cb066 100644 --- a/emacs/module/module-async.el +++ b/emacs/module/module-async.el @@ -1,7 +1,9 @@ ;;; module-async.el --- async functionality -*- lexical-binding: t; -*- - +;;; ;;; Commentary: - +;;; +;;; Enable async support in Emacs. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-avy.el b/emacs/module/module-avy.el index ec9a9a4..18cce8f 100644 --- a/emacs/module/module-avy.el +++ b/emacs/module/module-avy.el @@ -1,7 +1,8 @@ -;;; module-avy.el --- package management wrapper -*- lexical-binding: t; -*- +;;; module-avy.el --- quick jump -*- lexical-binding: t; -*- ;;; ;;; Commentary: -;;; Provides package management wrappers. +;;; +;;; Adds quick-jump functionality to Emacs. ;;; ;;; Code: diff --git a/emacs/module/module-browser.el b/emacs/module/module-browser.el index e01b6d2..e23b7a7 100644 --- a/emacs/module/module-browser.el +++ b/emacs/module/module-browser.el @@ -1,6 +1,10 @@ -;;; module-browser.el --- Brief description -*- lexical-binding: t; -*- +;;; module-browser.el --- open webpages -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Modern web browsers suck. Open a webpage from within Emacs, and +;;; allow opening with a sucky browser if you really have to. +;;; ;;; Code: (require 'eww) diff --git a/emacs/module/module-consult-projectile.el b/emacs/module/module-consult-projectile.el index e65a71a..9c6f7ce 100644 --- a/emacs/module/module-consult-projectile.el +++ b/emacs/module/module-consult-projectile.el @@ -1,6 +1,8 @@ ;;; module-consult-projectile.el --- consult/projectile integration +;;; ;;; Commentary: -;;; Integrate consult and projectile. +;;; +;;; Integrate consult with projectile. ;;; ;;; Code: diff --git a/emacs/module/module-consult.el b/emacs/module/module-consult.el index 5c078d7..1ebc01d 100644 --- a/emacs/module/module-consult.el +++ b/emacs/module/module-consult.el @@ -1,5 +1,7 @@ ;;; module-consult.el --- setup consult for emacs +;;; ;;; Commentary: +;;; ;;; Setup consult for Emacs. ;;; ;;; Code: diff --git a/emacs/module/module-ctags.el b/emacs/module/module-ctags.el index 49bb0f1..8b6eedf 100644 --- a/emacs/module/module-ctags.el +++ b/emacs/module/module-ctags.el @@ -1,6 +1,9 @@ -;;; module-ctags.el --- Brief description -*- lexical-binding: t; -*- +;;; module-ctags.el --- ctags functions -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Generate ctags from inside Emacs. Nifty! +;;; ;;; Code: diff --git a/emacs/module/module-denote-index.el b/emacs/module/module-denote-index.el index 98142e3..166fba1 100644 --- a/emacs/module/module-denote-index.el +++ b/emacs/module/module-denote-index.el @@ -1,8 +1,9 @@ ;;; module-denote-index.el -- index and metadata for denote notes ;;; ;;; Commentary: -;;; Provides a mechanism for maintaining an index of -;;; denote notes with useful metadata to facilitate search. +;;; +;;; Provides a mechanism for maintaining an index of denote notes with +;;; useful metadata to facilitate search. ;;; ;;; Code: diff --git a/emacs/module/module-denote-multidir.el b/emacs/module/module-denote-multidir.el index 91770bf..3c0cf0b 100644 --- a/emacs/module/module-denote-multidir.el +++ b/emacs/module/module-denote-multidir.el @@ -1,6 +1,7 @@ ;;; module-denote-multidir.el --- denote with multi-dir support ;;; ;;; Commentary: +;;; ;;; Extend denote with support for multiple notes directories. ;;; ;;; Code: diff --git a/emacs/module/module-denote.el b/emacs/module/module-denote.el index 56d43e4..764884b 100644 --- a/emacs/module/module-denote.el +++ b/emacs/module/module-denote.el @@ -1,7 +1,8 @@ -;;; module-denote.el --- note taking +;;; module-denote.el --- sane note taking ;;; ;;; Commentary: -;;; Configure denote for note taking purposes. +;;; +;;; Capturing and managing notes for sane people. ;;; ;;; Code: diff --git a/emacs/module/module-detached.el b/emacs/module/module-detached.el index 9534053..1041cbe 100644 --- a/emacs/module/module-detached.el +++ b/emacs/module/module-detached.el @@ -1,5 +1,7 @@ ;;; module-detached.el --- dtach for Emacs +;;; ;;; Commentary: +;;; ;;; Setup dtach and Emacs integration. ;;; ;;; Code: diff --git a/emacs/module/module-dired.el b/emacs/module/module-dired.el index cad6185..1936422 100644 --- a/emacs/module/module-dired.el +++ b/emacs/module/module-dired.el @@ -1,6 +1,8 @@ ;;; module-dired.el --- dired stuff +;;; ;;; Commentary: -;;; Configure Dired stuff. +;;; +;;; Configure settings and extensions for Dired. ;;; ;;; Code: diff --git a/emacs/module/module-embark.el b/emacs/module/module-embark.el index e0720bb..a1a430b 100644 --- a/emacs/module/module-embark.el +++ b/emacs/module/module-embark.el @@ -1,6 +1,10 @@ -;;; module-embark.el --- Brief description -*- lexical-binding: t; -*- +;;; module-embark.el --- context-sensitive actions -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Provide context-sensitive actions on current target, including +;;; minibuffer targets. +;;; ;;; Code: diff --git a/emacs/module/module-eshell.el b/emacs/module/module-eshell.el index b98c296..d644ff0 100644 --- a/emacs/module/module-eshell.el +++ b/emacs/module/module-eshell.el @@ -1,6 +1,7 @@ ;;; module-eshell.el --- eshell enhancements. ;;; Commentary: -;;; Configure eshell enhancements. +;;; +;;; Make eshell a little more usable. ;;; ;;; Code: diff --git a/emacs/module/module-eyecandy.el b/emacs/module/module-eyecandy.el index 598f9be..164b855 100644 --- a/emacs/module/module-eyecandy.el +++ b/emacs/module/module-eyecandy.el @@ -1,6 +1,9 @@ -;;; module-eyecandy.el --- Brief description -*- lexical-binding: t; -*- +;;; module-eyecandy.el --- make emacs shiny -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Add some eye candy to Emacs. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-golang-playground.el b/emacs/module/module-golang-playground.el index 9b4b01a..a672e43 100644 --- a/emacs/module/module-golang-playground.el +++ b/emacs/module/module-golang-playground.el @@ -1,6 +1,9 @@ -;;; module-golang-playground.el --- Brief description -*- lexical-binding: t; -*- +;;; module-golang-playground.el --- go experimentation sandbox -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; An experimentation sandbox for go programming. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-golang.el b/emacs/module/module-golang.el index f274fd7..c350f0f 100644 --- a/emacs/module/module-golang.el +++ b/emacs/module/module-golang.el @@ -1,6 +1,9 @@ -;;; module-golang.el --- Brief description -*- lexical-binding: t; -*- +;;; module-golang.el --- support golang -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Adds support for golang to Emacs. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-graphviz.el b/emacs/module/module-graphviz.el index 76f7d58..48a6d3b 100644 --- a/emacs/module/module-graphviz.el +++ b/emacs/module/module-graphviz.el @@ -1,6 +1,9 @@ -;;; module-graphviz.el --- Brief description -*- lexical-binding: t; -*- +;;; module-graphviz.el --- diagrams for old people -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Plain text diagramming software built before I was born. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-json.el b/emacs/module/module-json.el index f9724d9..a1360af 100644 --- a/emacs/module/module-json.el +++ b/emacs/module/module-json.el @@ -1,6 +1,9 @@ -;;; module-json.el --- Brief description -*- lexical-binding: t; -*- +;;; module-json.el --- JS based data serialization format -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Add support for working with JSON data to Emacs. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-kotlin.el b/emacs/module/module-kotlin.el index c209446..19b38f7 100644 --- a/emacs/module/module-kotlin.el +++ b/emacs/module/module-kotlin.el @@ -1,6 +1,10 @@ -;;; module-kotlin.el --- Brief description -*- lexical-binding: t; -*- +;;; module-kotlin.el --- java for the less insane -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; A more tolerable programming language that compiles to JVM byte +;;; code. Add Kotlin support to Emacs. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-llm.el b/emacs/module/module-llm.el index 14d87ef..dfc5f0c 100644 --- a/emacs/module/module-llm.el +++ b/emacs/module/module-llm.el @@ -25,7 +25,11 @@ (ellama-setup-keymap)) -(pkg/require 'org-ai) +;;(pkg/require 'org-ai) +(straight-use-package + '(org-ai :type git :host github :repo "lneely/org-ai")) + +(require 'org-ai) (add-hook 'org-mode-hook #'org-ai-mode) (provide 'module-llm) diff --git a/emacs/module/module-lmtf.el b/emacs/module/module-lmtf.el index f13e639..885f6a4 100644 --- a/emacs/module/module-lmtf.el +++ b/emacs/module/module-lmtf.el @@ -1,6 +1,9 @@ -;;; module-lmtf.el --- Brief description -*- lexical-binding: t; -*- +;;; module-lmtf.el --- lispy mctestface -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Make testing your shitty elisp a little easier. +;;; ;;; Code: diff --git a/emacs/module/module-magit.el b/emacs/module/module-magit.el index d97e084..a403a7b 100644 --- a/emacs/module/module-magit.el +++ b/emacs/module/module-magit.el @@ -1,5 +1,7 @@ ;;; module-magit.el --- git integration +;;; ;;; Commentary: +;;; ;;; Setup git integration with Emacs. ;;; ;;; Code: diff --git a/emacs/module/module-multi-cursor.el b/emacs/module/module-multi-cursor.el index bba2320..a63f60c 100644 --- a/emacs/module/module-multi-cursor.el +++ b/emacs/module/module-multi-cursor.el @@ -1,6 +1,8 @@ ;;; module-multi-cursor.el --- multiple cursors ;;; Commentary: -;;; Multiple cursor support for Emacs. +;;; +;;; Multiple cursor support for Emacs. Everyone else is doing it, +;;; right? ;;; ;;; Code: diff --git a/emacs/module/module-orderless.el b/emacs/module/module-orderless.el index c482e35..bd31f3c 100644 --- a/emacs/module/module-orderless.el +++ b/emacs/module/module-orderless.el @@ -1,6 +1,9 @@ -;;; module-orderless.el --- fuzzy search +;;; module-orderless.el --- efficient minibuffer completion +;;; ;;; Commentary: -;;; Setup fuzzy search for Emacs. +;;; +;;; Provides minibuffer completion for Emacs with fuzzy search +;;; capabilities. ;;; ;;; Code: diff --git a/emacs/module/module-org-denote.el b/emacs/module/module-org-denote.el index 59091ff..168f67b 100644 --- a/emacs/module/module-org-denote.el +++ b/emacs/module/module-org-denote.el @@ -1,6 +1,8 @@ ;;; module-org-denote.el --- denote extensions for org-mode +;;; ;;; Commentary: -;;; Setup org-mode denote extensions. +;;; +;;; Add denote-specific extensions to org-mode. ;;; ;;; Code: diff --git a/emacs/module/module-org.el b/emacs/module/module-org.el index ab117cb..52349b9 100644 --- a/emacs/module/module-org.el +++ b/emacs/module/module-org.el @@ -1,6 +1,8 @@ ;;; module-org.el --- org-mode +;;; ;;; Commentary: -;;; Setup org-mode for Emacs. +;;; +;;; Setup org-mode and extensions for Emacs. ;;; ;;; Code: diff --git a/emacs/module/module-plantuml.el b/emacs/module/module-plantuml.el index 9dd5bad..d2b9c75 100644 --- a/emacs/module/module-plantuml.el +++ b/emacs/module/module-plantuml.el @@ -1,6 +1,9 @@ -;;; module-plantuml.el --- Brief description -*- lexical-binding: t; -*- +;;; module-plantuml.el --- diagramming for less old people -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Build UML diagrams in plain text, so nobody can read them. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-projectile.el b/emacs/module/module-projectile.el index 106e7b1..00137c4 100644 --- a/emacs/module/module-projectile.el +++ b/emacs/module/module-projectile.el @@ -1,6 +1,8 @@ ;;; module-projectile.el --- project management +;;; ;;; Commentary: -;;; Project management for Emacs nerds. +;;; +;;; The de facto standard for Emacs projects. ;;; ;;; Code: diff --git a/emacs/module/module-protobuf.el b/emacs/module/module-protobuf.el index baae39e..0656646 100644 --- a/emacs/module/module-protobuf.el +++ b/emacs/module/module-protobuf.el @@ -1,6 +1,9 @@ -;;; module-protobuf.el --- Brief description -*- lexical-binding: t; -*- +;;; module-protobuf.el --- some google messaging shit -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Add support for working with Google protobuf message definitions. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-python.el b/emacs/module/module-python.el index 8d13bbe..ff3f239 100644 --- a/emacs/module/module-python.el +++ b/emacs/module/module-python.el @@ -1,6 +1,9 @@ -;;; module-python.el --- Brief description -*- lexical-binding: t; -*- +;;; module-python.el --- code that eats itself -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Add python language support to Emacs. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-rego.el b/emacs/module/module-rego.el index a4965fd..e379c38 100644 --- a/emacs/module/module-rego.el +++ b/emacs/module/module-rego.el @@ -1,6 +1,9 @@ -;;; module-browser.el --- Brief description -*- lexical-binding: t; -*- +;;; module-rego.el --- some policy language we use at work -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Adds support for rego, a policy definition language, to Emacs. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-rss.el b/emacs/module/module-rss.el index 429ef61..22ac98d 100644 --- a/emacs/module/module-rss.el +++ b/emacs/module/module-rss.el @@ -1,12 +1,13 @@ ;;; module-orderless.el --- rss feeds in emacs +;;; ;;; Commentary: +;;; ;;; Read RSS feeds in Emacs, stop browsing the web. ;;; ;;; Code: -(require 'module-pkg) +(require 'module-pkg) (pkg/require 'elfeed) (provide 'module-rss) - ;;; module-rss.el ends here. diff --git a/emacs/module/module-scratch.el b/emacs/module/module-scratch.el index 70ba597..643f010 100644 --- a/emacs/module/module-scratch.el +++ b/emacs/module/module-scratch.el @@ -1,5 +1,7 @@ ;;; module-scratch.el --- scratch buffer enhancements +;;; ;;; Commentary: +;;; ;;; Scratch buffer enhancements for Emacs. ;;; ;;; Code: @@ -8,6 +10,9 @@ (pkg/require 'scratch) (pkg/require 'persistent-scratch) +(defvar persistent-scratch-directory "~/.local/state/emacs/" + "The place to save persistent scratch buffers.") + (defun my-set-scratch-mode () "Set default scratch mode." (funcall 'text-mode)) diff --git a/emacs/module/module-snippets.el b/emacs/module/module-snippets.el index 9ef70da..2aa5beb 100644 --- a/emacs/module/module-snippets.el +++ b/emacs/module/module-snippets.el @@ -1,6 +1,10 @@ -;;; module-snippets.el --- Brief description -*- lexical-binding: t; -*- +;;; module-snippets.el --- text snippets -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Sometimes it's just too much effort to type the same shit over and +;;; over again. +;;; ;;; Code: diff --git a/emacs/module/module-syntax.el b/emacs/module/module-syntax.el index 35b9731..5a4dae9 100644 --- a/emacs/module/module-syntax.el +++ b/emacs/module/module-syntax.el @@ -1,14 +1,18 @@ -;;; module-syntax.el --- syntax related stuff +;;; module-syntax.el --- syntax checking and highlights ;;; Commentary: -;;; Configure syntax-related settings. +;;; +;;; Add syntax checking and special purpose highlights for +;;; programming. Let Emacs compile that shit code of yours into +;;; submission for you. ;;; ;;; Code: (require 'module-pkg) (pkg/require 'fic-mode) -(pkg/require 'flycheck) +(add-hook 'prog-mode-hook 'fic-mode) +(pkg/require 'flycheck) (global-flycheck-mode) (setq flycheck-emacs-lisp-load-path 'inherit) diff --git a/emacs/module/module-vertico.el b/emacs/module/module-vertico.el index eda45b5..e0f0fb3 100644 --- a/emacs/module/module-vertico.el +++ b/emacs/module/module-vertico.el @@ -1,6 +1,7 @@ -;;; module-vertico.el --- better minibuffer +;;; module-vertico.el --- vertical completion ;;; Commentary: -;;; Better minibuffer for Emacs. +;;; +;;; Vertical completion UI for Emacs minibuffer. ;;; ;;; Code: diff --git a/emacs/module/module-web.el b/emacs/module/module-web.el index 5a59090..97c4cf0 100644 --- a/emacs/module/module-web.el +++ b/emacs/module/module-web.el @@ -1,6 +1,10 @@ -;;; module-web.el --- Brief description -*- lexical-binding: t; -*- +;;; module-web.el --- a veritable fucking mess -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Add packages to Emacs to facilitate the absolute mess that is +;;; modern web programming. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-which-key.el b/emacs/module/module-which-key.el index 4eb7752..03bc998 100644 --- a/emacs/module/module-which-key.el +++ b/emacs/module/module-which-key.el @@ -1,6 +1,10 @@ -;;; module-which-key.el --- Brief description -*- lexical-binding: t; -*- +;;; module-which-key.el --- which-key -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Help remember which key to press in the current key chord +;;; "context," because memorization is overrated. +;;; ;;; Code: (require 'module-pkg) diff --git a/emacs/module/module-yaml.el b/emacs/module/module-yaml.el index 45fe669..87dc5fe 100644 --- a/emacs/module/module-yaml.el +++ b/emacs/module/module-yaml.el @@ -1,6 +1,9 @@ -;;; module-yaml.el --- Brief description -*- lexical-binding: t; -*- +;;; module-yaml.el --- because we needed another fucking data format -*- lexical-binding: t; -*- +;;; ;;; Commentary: - +;;; +;;; Adds support for working with YAML files to Emacs. +;;; ;;; Code: (require 'module-pkg)