From 01c9348b0a88a0f03eae37ea91d587fa3f148c9c Mon Sep 17 00:00:00 2001 From: Jessie Hildebrandt Date: Thu, 22 Dec 2022 07:11:44 -0500 Subject: [PATCH] Fix lack of terminating punctuation in docstrings --- init.el | 138 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 69 insertions(+), 69 deletions(-) diff --git a/init.el b/init.el index befa667..91fe411 100644 --- a/init.el +++ b/init.el @@ -294,7 +294,7 @@ DOCSTRING is an optional form that is discarded upon expansion." (apply func args))) (editor-feature emacs - "Provides an extensible, customizable, self-documenting real-time display editor" + "Provides an extensible, customizable, self-documenting real-time display editor." :config @@ -394,7 +394,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature autorevert - "Displays on-disk changes to files in unmodified buffers automatically" + "Displays on-disk changes to files in unmodified buffers automatically." :config (global-auto-revert-mode)) @@ -403,7 +403,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature display-line-numbers - "Displays the absolute number of each line in a buffer" + "Displays the absolute number of each line in a buffer." :custom (display-line-numbers-width-start 100 "Count number of lines (+100) in buffer for initial line number width") :hook @@ -418,7 +418,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature elec-pair - "Enables automatic pairing of most paired delimiters" + "Enables automatic pairing of most paired delimiters." :hook (prog-mode-hook . electric-pair-local-mode)) @@ -458,7 +458,7 @@ DOCSTRING is an optional form that is discarded upon expansion." (eshell)))) (editor-feature eshell - "Provides a shell-like interpreter that can process shell or lisp commands" + "Provides a shell-like interpreter that can process shell or Lisp commands." :custom (eshell-banner-message '(concat "\n" (if (executable-find "fortune") (shell-command-to-string "fortune -s computers") @@ -489,7 +489,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; the local keymap bindings are set up here (editor-feature esh-mode - "eshell module that handles input from the user" + "Handles input from the user and provides `eshell-mode' for eshell." :bind (:map eshell-mode-map ("C-c RET" . nil) @@ -511,7 +511,7 @@ DOCSTRING is an optional form that is discarded upon expansion." (make-directory user/lock-file-directory :parents) (editor-feature files - "Defines most of Emacs' file-handling functionality" + "Defines most of Emacs' file-handling functionality." :custom @@ -552,7 +552,7 @@ DOCSTRING is an optional form that is discarded upon expansion." (setq user/initial-frame-created t))))) (editor-feature frame - "Graphical frame configuration" + "Graphical frame configuration." :config (mapc #'user/set-up-frame (frame-list)) :hook @@ -563,7 +563,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature hl-line - "Highlights the current line in a buffer" + "Highlights the current line in a buffer." :config (global-hl-line-mode)) @@ -572,7 +572,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature ispell - "Checks for spelling errors and suggests corrections from a dictionary" + "Checks for spelling errors and suggests corrections from a dictionary." :bind ("C-c ' '" . ispell) ("C-c ' w" . ispell-word) @@ -586,7 +586,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature paren - "Highlights matching delimiter pairs under the cursor" + "Highlights matching delimiter pairs under the cursor." :config (show-paren-mode) :custom @@ -597,7 +597,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature savehist - "Persists minibuffer history between sessions" + "Persists minibuffer history between sessions." :config (savehist-mode)) @@ -606,7 +606,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature server - "Allows Emacs to operate as a server for other Emacs processes" + "Allows Emacs to operate as a server for other Emacs processes." :config ;; When running in a server/client configuration, we don't want the ;; foreground/background colors in `default-frame-alist' to overwrite the @@ -622,7 +622,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature so-long - "Deactivates certain editor features when opening files with very long lines" + "Deactivates certain editor features when opening files with very long lines." :config (global-so-long-mode)) @@ -631,7 +631,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature subword - "Enables detection of subwords as words in camel case or pascal case names" + "Enables detection of subwords as words in camel case or pascal case names." :config (global-subword-mode)) @@ -640,7 +640,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature tab-bar - "Provides a frame-wide tab bar that allows for tabbed workspace switching" + "Provides a frame-wide tab bar that allows for tabbed workspace switching." :custom (tab-bar-format '(tab-bar-format-tabs tab-bar-separator)) (tab-bar-close-button-show nil "Disable close button on tabs")) @@ -650,7 +650,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature tab-line - "Provides a buffer-local tab line that facilitates quick buffer switching" + "Provides a buffer-local tab line that facilitates quick buffer switching." :custom (tab-line-close-button-show nil "Disable close button on tabs") (tab-line-new-button-show nil "Disable tab creation button") @@ -663,7 +663,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature uniquify - "Provides better unique names when there are name conflicts between buffers" + "Provides better unique names when there are name conflicts between buffers." :custom (uniquify-buffer-name-style 'forward "Show file path before buffer name") (uniquify-after-kill-buffer-p t "Update buffer names after killing") @@ -674,7 +674,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (editor-feature whitespace - "Visualizes blank characters" + "Visualizes blank characters." :custom (whitespace-line-column nil "Use the value of `fill-column' instead of a set value") (whitespace-display-mappings '((tab-mark 9 [8677 9]) ; Tab @@ -704,7 +704,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; TEMP: Remove :load-path and change to `external-package' once ;; adwaita-dark-theme is available in MELPA (editor-feature adwaita-dark-theme - "Provides the `adwaita-dark' theme and custom fringe bitmaps" + "Provides the `adwaita-dark' theme and custom fringe bitmaps." :load-path "adwaita-dark/" :config @@ -725,43 +725,43 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package csharp-mode - "Major mode for C#" + "Major mode for C#." :mode ("\\.cs\\'" . csharp-mode)) (external-package dart-mode - "Major mode for Dart" + "Major mode for Dart." :mode ("\\.dart\\'" . dart-mode)) (external-package docker-compose-mode - "Major mdoe for docker-compose files" + "Major mdoe for docker-compose files." :mode ("\\docker-compose.yml\\'" . docker-compose-mode)) (external-package dockerfile-mode - "Major mode for Docker files" + "Major mode for Docker files." :mode ("\\Dockerfile\\'" . dockerfile-mode)) (external-package fennel-mode - "Major mode for Fennel" + "Major mode for Fennel." :mode ("\\.fnl\\'" . fennel-mode)) (external-package fish-mode - "Major mode for fish files" + "Major mode for fish files." :mode ("\\.fish\\'" . fish-mode)) (external-package gdscript-mode - "Major mode for GDScript" + "Major mode for GDScript." :mode ("\\.gd\\'" . gdscript-mode) ("\\.tscn\\'" . gdscript-mode)) (external-package git-modes - "Major modes for git files" + "Major modes for git files." :mode ("\\.gitignore\\'" . gitignore-mode) ("\\.gitconfig\\'" . gitconfig-mode) @@ -769,39 +769,39 @@ DOCSTRING is an optional form that is discarded upon expansion." ("\\.gitattributes\\'" . gitattributes-mode)) (external-package glsl-mode - "Major mode for GLSL" + "Major mode for GLSL." :mode ("\\.frag\\'" . glsl-mode) ("\\.vert\\'" . glsl-mode)) (external-package json-mode - "Major mode for JSON files" + "Major mode for JSON files." :mode ("\\.json\\'" . json-mode)) (external-package kotlin-mode - "Major mode for Kotlin" + "Major mode for Kotlin." :mode ("\\.kt\\'" . kotlin-mode)) (external-package lua-mode - "Major mode for Lua" + "Major mode for Lua." :mode (("\\.lua\\'" . lua-mode) ("\\.rockspec\\'" . lua-mode))) (external-package rust-mode - "Major mode for Rust" + "Major mode for Rust." :mode ("\\.rs\\'" . rust-mode)) (external-package typescript-mode - "Major mode for TypeScript" + "Major mode for TypeScript." :mode ("\\.tsx?\\'" . typescript-mode)) (external-package web-mode - "Major mode for web templates" + "Major mode for web templates." :custom (web-mode-markup-indent-offset 2 "Use 2 spaces instead of 4 for indenting HTML elements") (web-mode-enable-auto-quoting nil "Do not automatically insert quotes after HTML attributes") @@ -814,7 +814,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package anzu - "Displays matching and replacement information in the mode line" + "Displays matching and replacement information in the mode line." :config (global-anzu-mode) :bind @@ -827,7 +827,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package bufler - "Presents open buffers in a grouped and organized menu" + "Presents open buffers in a grouped and organized menu." :custom (bufler-columns '("Name" "Path")) (bufler-list-group-separators '((0 . "\n"))) @@ -888,7 +888,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package consult - "Provides a number of autocompletion-enhanced replacements for default commands" + "Provides a number of autocompletion-enhanced replacements for default commands." :config ;; `eshell-mode-map' is not available until the `esh-mode' module is loaded (eval-after-load 'esh-mode (lambda () @@ -909,7 +909,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package corfu - "Enhances completion suggestions with a visible popup" + "Enhances completion suggestions with a visible popup." :init (global-corfu-mode) :config @@ -936,7 +936,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package corfu-terminal - "Allows Corfu to function when not running in a graphical frame" + "Allows Corfu to function when not running in a graphical frame." :when (not (display-graphic-p)) :config @@ -947,7 +947,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package diff-hl - "Highlights uncommited changes to version controlled files in the gutter" + "Highlights uncommited changes to version controlled files in the gutter." :config (global-diff-hl-mode) (diff-hl-flydiff-mode)) @@ -957,7 +957,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package fish-completion - "Sources shell completion candidates from the fish shell" + "Sources shell completion candidates from the fish shell." :when (executable-find "fish") :hook @@ -968,7 +968,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package flycheck - "Enables on-the-fly syntax checking for supported languages" + "Enables on-the-fly syntax checking for supported languages." :custom (flycheck-idle-change-delay 2 "Wait for 2 seconds of idling before invoking any checkers") (flycheck-check-syntax-automatically '(save idle-change mode-enabled)) @@ -982,7 +982,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package fussy - "Provides a flexible completion style that scores and sorts candidates" + "Provides a flexible completion style that scores and sorts candidates." :custom (completion-ignore-case t "Ignore case in completion candidates") (completion-category-defaults nil "Disable category-specific completion styles") @@ -994,7 +994,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package hl-todo - "Highlights certain keywords in comments" + "Highlights certain keywords in comments." :custom (hl-todo-keyword-faces '(("TODO" . hl-todo) ("TEMP" . hl-todo) @@ -1009,7 +1009,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package kind-icon - "Adds contextual icons in front of Corfu completion candidates" + "Adds contextual icons in front of Corfu completion candidates." :config (add-to-list 'corfu-margin-formatters #'kind-icon-margin-formatter) :custom @@ -1021,7 +1021,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package ligature - "Enables support for mapping characters to ligatures" + "Enables support for mapping characters to ligatures." :config (ligature-set-ligatures 'prog-mode '(;; This set of ligatures is for Fira Code, but @@ -1091,7 +1091,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package lsp-mode - "Provides Language Server Protocol support and integration" + "Provides Language Server Protocol support and integration." :custom (lsp-eldoc-enable-hover nil "Do not print symbol eldoc information in the echo area") (lsp-signature-auto-activate nil "Do not display function signature docs in the echo area") @@ -1114,7 +1114,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package lsp-ui - "Provides higher-level UI integration of LSP features for `lsp-mode'" + "Provides higher-level UI integration of LSP features for `lsp-mode'." :config (setq lsp-ui-doc-border (face-background 'lsp-ui-doc-background)) :custom @@ -1139,7 +1139,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package magit - "Provides a visual interface to git" + "Provides a visual interface to git." :custom (magit-status-margin '(t age magit-log-margin-width nil 18) "Display margin in status buffer") (git-commit-summary-max-length 50 "Highlight characters in commit summaries past column 50") @@ -1152,7 +1152,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package magit-todos - "Shows a list of keyword-containing comments in the Magit status buffer" + "Shows a list of keyword-containing comments in the Magit status buffer." :hook (magit-mode-hook . magit-todos-mode)) @@ -1161,7 +1161,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package marginalia - "Adds informative annotations to completion candidates in the minibuffer" + "Adds informative annotations to completion candidates in the minibuffer." :config (defun marginalia--file-owner (_) "") (defun marginalia--file-modes (_) "") @@ -1174,7 +1174,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package mood-line - "Gives the mode-line a cleaner appearance" + "Gives the mode-line a cleaner appearance." :config (mood-line-mode) :custom @@ -1185,7 +1185,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package multiple-cursors - "Provides the ability to summon additional cursors" + "Provides the ability to summon additional cursors." :bind (("C->" . mc/mark-next-like-this) ("C-<" . mc/mark-previous-like-this) @@ -1197,7 +1197,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package neotree - "Displays an interactive directory/file tree in a side window" + "Displays an interactive directory/file tree in a side window." :custom (neo-smart-open t "Jump to current file when focusing the neotree window") (neo-window-width 30 "Limit neotree window width to 30 columns") @@ -1217,7 +1217,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; Load Package-Lint (external-package package-lint - "Provides a command for linting Emacs Lisp packages" + "Provides a command for linting Emacs Lisp packages." :commands (package-lint-current-buffer)) @@ -1226,7 +1226,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package page-break-lines - "Displays form feed characters as horizontal rules" + "Displays form feed characters as horizontal rules." :config (global-page-break-lines-mode)) @@ -1235,7 +1235,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package rainbow-delimiters - "Highlights matching delimiters with colors according to depth" + "Highlights matching delimiters with colors according to depth." :hook (prog-mode-hook . rainbow-delimiters-mode)) @@ -1244,7 +1244,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package resize-window - "Provides an overlay that allows for quick window management inputs" + "Provides an overlay that allows for quick window management inputs." :bind ("C-c w" . resize-window)) @@ -1253,7 +1253,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package restclient - "Allows for the execution of HTTP queries from plain-text query sheets" + "Allows for the execution of HTTP queries from plain-text query sheets." :config (defun restclient () "Open the restclient buffer, (re)creating it if not present." @@ -1269,7 +1269,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package slime - "Provides an interactive programming environment for Common Lisp" + "Provides an interactive programming environment for Common Lisp." :custom (inferior-lisp-program (executable-find "sbcl") "Set SBCL as the default Common Lisp implementation") :commands @@ -1280,7 +1280,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package slime-docker - "Integrates SLIME with Lisps running in Docker containers" + "Integrates SLIME with Lisps running in Docker containers." :custom (slime-docker-program "sbcl" "Set SBCL as the default Common Lisp implementation in containers") :commands @@ -1291,7 +1291,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package string-inflection - "Provides case conversion functions for symbols and strings" + "Provides case conversion functions for symbols and strings." :commands (string-inflection-underscore-function string-inflection-pascal-case-function @@ -1305,7 +1305,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package solaire-mode - "Recolors special buffers to distinguish them from regular buffers" + "Recolors special buffers to distinguish them from regular buffers." :custom (solaire-mode-real-buffer-fn (lambda () (and (buffer-name (buffer-base-buffer)) @@ -1322,7 +1322,7 @@ DOCSTRING is an optional form that is discarded upon expansion." (defconst user/undo-history-directory (locate-user-emacs-file "undo-history/") "Location of undo-fu-session history backups.") (external-package undo-fu-session - "Saves and recovers undo history of files between editing sessions" + "Saves and recovers undo history of files between editing sessions." :config (global-undo-fu-session-mode) :custom @@ -1333,7 +1333,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package vertico - "Provides a vertical autocompletion UI in the minibuffer" + "Provides a vertical autocompletion UI in the minibuffer." :custom (vertico-cycle t "Enable wrap-around candidate cycling") (vertico-count 9 "Display a maximum of 9 candidates in the minibuffer") @@ -1355,7 +1355,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package vundo - "Visualizes undo history as a tree in an interactive buffer" + "Visualizes undo history as a tree in an interactive buffer." :custom (vundo-glyph-alist vundo-unicode-symbols "Visualize undo history with pretty unicode symbols") :hook @@ -1369,7 +1369,7 @@ DOCSTRING is an optional form that is discarded upon expansion." ;; ---------------------------------- ;; (external-package writeroom-mode - "Centers the working text area in the active buffer" + "Centers the working text area in the active buffer." :custom (writeroom-width 140 "Set the working area width to 140 columns.") (writeroom-maximize-window nil "Do not maximize the active window.") @@ -1390,7 +1390,7 @@ DOCSTRING is an optional form that is discarded upon expansion." (defconst user/yasnippet-directory (locate-user-emacs-file "snippet/") "Location of user snippet files.") (external-package yasnippet - "Allows for the definition and automatic expansion of text templates" + "Allows for the definition and automatic expansion of text templates." :custom (yas-also-indent-empty-lines t "Indent lines in expanded templates even if empty") (yas-also-auto-indent-first-line t "Always indent first line in expanded templates")