summaryrefslogtreecommitdiff
path: root/elisp
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2022-07-14 14:33:38 +0200
committerJonas Bernoulli <jonas@bernoul.li>2024-07-06 17:37:23 +0200
commitde52f0e36f1709181c1ce4e787d79208fa2cb870 (patch)
treeb206b89999663c3aeed08b267c741a8de4c305ba /elisp
parent9197acbdbde392fc53ad0f2be2cef83e452f1d28 (diff)
downloadgeiser-de52f0e36f1709181c1ce4e787d79208fa2cb870.tar.gz
geiser-de52f0e36f1709181c1ce4e787d79208fa2cb870.tar.bz2
Cleanup library headers
- In the summary line, use three dashes to separate the file name from the summary. That is the convention, which some tools depend on, and for some libraries we already did it here too. - Capitalize the first word in the summary. That is the convention, and for some libraries we already did it here too. - For libraries that have a commentary, make sure it is placed in a "Commentary:" section. - Make sure the "Code:" heading, which separates the header from the code part of the library, exists in all files.
Diffstat (limited to 'elisp')
-rw-r--r--elisp/geiser-autodoc.el2
-rw-r--r--elisp/geiser-base.el9
-rw-r--r--elisp/geiser-capf.el3
-rw-r--r--elisp/geiser-compile.el2
-rw-r--r--elisp/geiser-completion.el2
-rw-r--r--elisp/geiser-connection.el2
-rw-r--r--elisp/geiser-debug.el2
-rw-r--r--elisp/geiser-doc.el2
-rw-r--r--elisp/geiser-edit.el2
-rw-r--r--elisp/geiser-eval.el4
-rw-r--r--elisp/geiser-image.el2
-rw-r--r--elisp/geiser-impl.el2
-rw-r--r--elisp/geiser-log.el2
-rw-r--r--elisp/geiser-menu.el2
-rw-r--r--elisp/geiser-mode.el2
-rw-r--r--elisp/geiser-popup.el2
-rw-r--r--elisp/geiser-reload.el2
-rw-r--r--elisp/geiser-syntax.el2
-rw-r--r--elisp/geiser-table.el2
-rw-r--r--elisp/geiser-xref.el3
20 files changed, 28 insertions, 23 deletions
diff --git a/elisp/geiser-autodoc.el b/elisp/geiser-autodoc.el
index 67d3213..e22c9d4 100644
--- a/elisp/geiser-autodoc.el
+++ b/elisp/geiser-autodoc.el
@@ -1,4 +1,4 @@
-;;; geiser-autodoc.el -- autodoc mode -*- lexical-binding: t; -*-
+;;; geiser-autodoc.el --- Autodoc mode -*- lexical-binding: t; -*-
;; Copyright (C) 2009, 2010, 2011, 2012, 2015, 2016, 2021, 2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-base.el b/elisp/geiser-base.el
index 6100898..4194da5 100644
--- a/elisp/geiser-base.el
+++ b/elisp/geiser-base.el
@@ -1,4 +1,4 @@
-;;; geiser-base.el --- shared bits -*- lexical-binding: t -*-
+;;; geiser-base.el --- Shared bits -*- lexical-binding: t -*-
;; Copyright (C) 2009, 2010, 2012, 2013, 2015, 2016, 2019, 2024 Jose Antonio Ortega Ruiz
@@ -7,8 +7,10 @@
;; have received a copy of the license along with this program. If
;; not, see <http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5>.
-;; Settings and vars shared by all geiser modules, including little
-;; utilities and emacsen compatibility bits.
+;;; Commentary:
+
+;; Settings and variables shared by all geiser modules, including
+;; little utilities and emacsen compatibility bits.
;;; Code:
@@ -65,7 +67,6 @@
(insert str)
(put-text-property p (point) 'face face)))
-
(defmacro geiser--save-msg (&rest body)
(let ((msg (make-symbol "msg")))
`(let ((,msg (current-message)))
diff --git a/elisp/geiser-capf.el b/elisp/geiser-capf.el
index 542cac7..a3c47a3 100644
--- a/elisp/geiser-capf.el
+++ b/elisp/geiser-capf.el
@@ -1,4 +1,4 @@
-;;; geiser-capf.el -- Setup for Geiser's CAPFs -*- lexical-binding: t; -*-
+;;; geiser-capf.el --- Setup for Geiser's CAPFs -*- lexical-binding: t; -*-
;; Copyright (c) 2022 Jose Antonio Ortega Ruiz
@@ -10,6 +10,7 @@
;; Start date: Sat Apr 23, 2022 18:39
+;;; Code:
(require 'geiser-autodoc)
(require 'geiser-impl)
diff --git a/elisp/geiser-compile.el b/elisp/geiser-compile.el
index 3897499..9458f4d 100644
--- a/elisp/geiser-compile.el
+++ b/elisp/geiser-compile.el
@@ -1,4 +1,4 @@
-;;; geiser-compile.el -- compile/load scheme files -*- lexical-binding: t; -*-
+;;; geiser-compile.el --- Compile/load scheme files -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2013, 2016, 2018, 2021-2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-completion.el b/elisp/geiser-completion.el
index 584e9e0..f68b8fa 100644
--- a/elisp/geiser-completion.el
+++ b/elisp/geiser-completion.el
@@ -1,4 +1,4 @@
-;;; geiser-completion.el -- tab completion -*- lexical-binding: t; -*-
+;;; geiser-completion.el --- Tab completion -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2012, 2018, 2020-2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-connection.el b/elisp/geiser-connection.el
index 2b3c4b9..af185b4 100644
--- a/elisp/geiser-connection.el
+++ b/elisp/geiser-connection.el
@@ -1,4 +1,4 @@
-;;; geiser-connection.el -- talking to a scheme process -*- lexical-binding: t; -*-
+;;; geiser-connection.el --- Talking to a scheme process -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2011, 2013, 2021-2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-debug.el b/elisp/geiser-debug.el
index 88f1e72..c5e30a9 100644
--- a/elisp/geiser-debug.el
+++ b/elisp/geiser-debug.el
@@ -1,4 +1,4 @@
-;;; geiser-debug.el -- displaying debug and eval info -*- lexical-binding: t; -*-
+;;; geiser-debug.el --- Displaying debug and eval info -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2016, 2020-2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-doc.el b/elisp/geiser-doc.el
index de18d9f..2ebe39b 100644
--- a/elisp/geiser-doc.el
+++ b/elisp/geiser-doc.el
@@ -1,4 +1,4 @@
-;;; geiser-doc.el -- accessing scheme-provided documentation -*- lexical-binding: t; -*-
+;;; geiser-doc.el --- Accessing scheme-provided documentation -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2016, 2021-2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-edit.el b/elisp/geiser-edit.el
index 1954062..54f6c62 100644
--- a/elisp/geiser-edit.el
+++ b/elisp/geiser-edit.el
@@ -1,4 +1,4 @@
-;;; geiser-edit.el -- scheme edit locations -*- lexical-binding: t; -*-
+;;; geiser-edit.el --- Scheme edit locations -*- lexical-binding: t; -*-
;; Copyright (C) 2009, 2010, 2012, 2013, 2019-2024 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-eval.el b/elisp/geiser-eval.el
index 5e4c566..8f58c25 100644
--- a/elisp/geiser-eval.el
+++ b/elisp/geiser-eval.el
@@ -1,4 +1,4 @@
-;;; geiser-eval.el -- sending scheme code for evaluation -*- lexical-binding: t; -*-
+;;; geiser-eval.el --- Sending scheme code for evaluation -*- lexical-binding: t; -*-
;; Copyright (C) 2009, 2010, 2011, 2012, 2013, 2015, 2021, 2023 Jose Antonio Ortega Ruiz
@@ -9,6 +9,8 @@
;; Start date: Sat Feb 07, 2009 22:35
+;;; Commentary:
+
;; Functions, building on top of geiser-connection, to evaluate scheme
;; code.
diff --git a/elisp/geiser-image.el b/elisp/geiser-image.el
index 62cb970..fc2c49d 100644
--- a/elisp/geiser-image.el
+++ b/elisp/geiser-image.el
@@ -1,4 +1,4 @@
-;;; geiser-image.el -- support for image display -*- lexical-binding: t; -*-
+;;; geiser-image.el --- Support for image display -*- lexical-binding: t; -*-
;; Copyright (c) 2012, 2015 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-impl.el b/elisp/geiser-impl.el
index 3034cb3..f95034a 100644
--- a/elisp/geiser-impl.el
+++ b/elisp/geiser-impl.el
@@ -1,4 +1,4 @@
-;;; geiser-impl.el -- generic support for scheme implementations -*- lexical-binding: t; -*-
+;;; geiser-impl.el --- Generic support for scheme implementations -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2010, 2012-2013, 2015-2016, 2019, 2021-2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-log.el b/elisp/geiser-log.el
index ead748f..fcd2e1a 100644
--- a/elisp/geiser-log.el
+++ b/elisp/geiser-log.el
@@ -1,4 +1,4 @@
-;;; geiser-log.el -- logging utilities -*- lexical-binding: t; -*-
+;;; geiser-log.el --- Logging utilities -*- lexical-binding: t; -*-
;; Copyright (C) 2009, 2010, 2012, 2019, 2021, 2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-menu.el b/elisp/geiser-menu.el
index 9492f3c..afc0353 100644
--- a/elisp/geiser-menu.el
+++ b/elisp/geiser-menu.el
@@ -1,4 +1,4 @@
-;;; geiser-menu.el -- menu and keymaps definition -*- lexical-binding: t; -*-
+;;; geiser-menu.el --- Menu and keymaps definition -*- lexical-binding: t; -*-
;; Copyright (c) 2010, 2012 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-mode.el b/elisp/geiser-mode.el
index df8493a..c8a9e0d 100644
--- a/elisp/geiser-mode.el
+++ b/elisp/geiser-mode.el
@@ -1,4 +1,4 @@
-;;; geiser-mode.el -- minor mode for scheme buffers -*- lexical-binding: t; -*-
+;;; geiser-mode.el --- Minor mode for scheme buffers -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2017, 2020, 2022, 2024 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-popup.el b/elisp/geiser-popup.el
index c838dd7..bfd5055 100644
--- a/elisp/geiser-popup.el
+++ b/elisp/geiser-popup.el
@@ -1,4 +1,4 @@
-;;; geiser-popup.el -- popup windows -*- lexical-binding: t; -*-
+;;; geiser-popup.el --- Popup windows -*- lexical-binding: t; -*-
;; Copyright (C) 2009, 2010, 2012, 2013 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-reload.el b/elisp/geiser-reload.el
index 4f5f964..25560c6 100644
--- a/elisp/geiser-reload.el
+++ b/elisp/geiser-reload.el
@@ -1,4 +1,4 @@
-;;; geiser-reload.el -- unload/load geiser packages -*- lexical-binding: t; -*-
+;;; geiser-reload.el --- Unload/load geiser packages -*- lexical-binding: t; -*-
;; Copyright (C) 2009, 2010, 2012, 2020, 2021, 2022, 2024 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-syntax.el b/elisp/geiser-syntax.el
index dbbf9e5..af750fb 100644
--- a/elisp/geiser-syntax.el
+++ b/elisp/geiser-syntax.el
@@ -1,4 +1,4 @@
-;;; geiser-syntax.el -- utilities for parsing scheme syntax -*- lexical-binding: t; -*-
+;;; geiser-syntax.el --- Utilities for parsing scheme syntax -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2016, 2019-2022 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-table.el b/elisp/geiser-table.el
index 619d563..dc3925b 100644
--- a/elisp/geiser-table.el
+++ b/elisp/geiser-table.el
@@ -1,4 +1,4 @@
-;;; geiser-table.el -- table creation -*- lexical-binding: t; -*-
+;;; geiser-table.el --- Table creation -*- lexical-binding: t; -*-
;; Copyright (C) 2009, 2010, 2012 Jose Antonio Ortega Ruiz
diff --git a/elisp/geiser-xref.el b/elisp/geiser-xref.el
index 0726d62..8f982ff 100644
--- a/elisp/geiser-xref.el
+++ b/elisp/geiser-xref.el
@@ -1,4 +1,4 @@
-;;; geiser-xref.el -- utilities for cross-referencing -*- lexical-binding: t; -*-
+;;; geiser-xref.el --- Utilities for cross-referencing -*- lexical-binding: t; -*-
;; Copyright (C) 2009, 2010, 2012, 2022 Jose Antonio Ortega Ruiz
@@ -24,6 +24,7 @@
;;; Customization:
+
(defgroup geiser-xref nil
"Options for cross-referencing commands."
:group 'geiser)