summaryrefslogtreecommitdiff
path: root/elisp
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2020-02-25 14:32:18 +0100
committerJonas Bernoulli <jonas@bernoul.li>2020-03-27 21:38:45 +0100
commit3ceb31b71824e59e3f000edf7cb09ab86616d723 (patch)
tree25e32dd1cbb88878aaa4df3fe88b2f860cb0ebc7 /elisp
parent715f4c0ee0f50b251679e55650cedcae3a246b57 (diff)
downloadgeiser-3ceb31b71824e59e3f000edf7cb09ab86616d723.tar.gz
geiser-3ceb31b71824e59e3f000edf7cb09ab86616d723.tar.bz2
Mark the beginning of code part of elisp libraries with Code: heading
It's the convention and by following it we make a big step towards supporting outline navigation. The convention doesn't say much about what parts of the code are supposed to be part of that sections and what parts belong in a subsequent section. Here we put the `require' forms in this section and maybe some setup code, that's a popular approach. In most cases there was " " where we now insert "Code:". They both serve a similar purpose and we keep the former because some users depend on that for navigation. We even add this " " in libraries where it previously was missing. In some cases the permission statement was followed by a commentary, which obviously does not belong in the "Code:" section. In such cases add the conventional "Commentary:" section.
Diffstat (limited to 'elisp')
-rw-r--r--elisp/geiser-autodoc.el1
-rw-r--r--elisp/geiser-base.el2
-rw-r--r--elisp/geiser-company.el1
-rw-r--r--elisp/geiser-compile.el1
-rw-r--r--elisp/geiser-completion.el1
-rw-r--r--elisp/geiser-connection.el5
-rw-r--r--elisp/geiser-custom.el1
-rw-r--r--elisp/geiser-debug.el1
-rw-r--r--elisp/geiser-doc.el1
-rw-r--r--elisp/geiser-edit.el1
-rw-r--r--elisp/geiser-eval.el1
-rw-r--r--elisp/geiser-image.el1
-rw-r--r--elisp/geiser-impl.el1
-rw-r--r--elisp/geiser-log.el5
-rw-r--r--elisp/geiser-menu.el2
-rw-r--r--elisp/geiser-mode.el1
-rw-r--r--elisp/geiser-popup.el3
-rw-r--r--elisp/geiser-reload.el1
-rw-r--r--elisp/geiser-repl.el1
-rw-r--r--elisp/geiser-syntax.el1
-rw-r--r--elisp/geiser-table.el1
-rw-r--r--elisp/geiser-xref.el1
-rw-r--r--elisp/geiser.el5
23 files changed, 36 insertions, 3 deletions
diff --git a/elisp/geiser-autodoc.el b/elisp/geiser-autodoc.el
index 893d773..bd41484 100644
--- a/elisp/geiser-autodoc.el
+++ b/elisp/geiser-autodoc.el
@@ -10,6 +10,7 @@
;; Start date: Sun Feb 08, 2009 19:44
+;;; Code:
(require 'geiser-eval)
(require 'geiser-syntax)
diff --git a/elisp/geiser-base.el b/elisp/geiser-base.el
index 95fdc03..327a91f 100644
--- a/elisp/geiser-base.el
+++ b/elisp/geiser-base.el
@@ -10,6 +10,8 @@
;; Settings and vars shared by all geiser modules, including little
;; utilities and emacsen compatibility bits.
+
+;;; Code:
;;; Emacs compatibility:
(require 'ring)
diff --git a/elisp/geiser-company.el b/elisp/geiser-company.el
index 52524f9..70bb3b8 100644
--- a/elisp/geiser-company.el
+++ b/elisp/geiser-company.el
@@ -10,6 +10,7 @@
;; Start date: Mon Aug 24, 2009 12:44
+;;; Code:
(require 'geiser-autodoc)
(require 'geiser-completion)
diff --git a/elisp/geiser-compile.el b/elisp/geiser-compile.el
index 41a7e1e..ce3a0b1 100644
--- a/elisp/geiser-compile.el
+++ b/elisp/geiser-compile.el
@@ -10,6 +10,7 @@
;; Start date: Wed Feb 11, 2009 00:16
+;;; Code:
(require 'geiser-debug)
(require 'geiser-autodoc)
diff --git a/elisp/geiser-completion.el b/elisp/geiser-completion.el
index 7af2e8e..7583b5f 100644
--- a/elisp/geiser-completion.el
+++ b/elisp/geiser-completion.el
@@ -10,6 +10,7 @@
;; Start date: Mon Feb 09, 2009 22:21
+;;; Code:
(require 'geiser-impl)
(require 'geiser-eval)
diff --git a/elisp/geiser-connection.el b/elisp/geiser-connection.el
index 510afe9..4fb7363 100644
--- a/elisp/geiser-connection.el
+++ b/elisp/geiser-connection.el
@@ -9,11 +9,14 @@
;; Start date: Sat Feb 07, 2009 21:11
-
+;;; Commentary:
;; Connection datatype and functions for managing request queues
;; between emacs and inferior guile processes.
+
+;;; Code:
+
(require 'geiser-log)
(require 'geiser-syntax)
(require 'geiser-base)
diff --git a/elisp/geiser-custom.el b/elisp/geiser-custom.el
index a6019bb..8d04885 100644
--- a/elisp/geiser-custom.el
+++ b/elisp/geiser-custom.el
@@ -10,6 +10,7 @@
;; Start date: Sat Feb 14, 2009 21:49
+;;; Code:
(require 'font-lock)
(require 'geiser-base)
diff --git a/elisp/geiser-debug.el b/elisp/geiser-debug.el
index 130594f..51fa9e5 100644
--- a/elisp/geiser-debug.el
+++ b/elisp/geiser-debug.el
@@ -10,6 +10,7 @@
;; Start date: Mon Feb 23, 2009 22:34
+;;; Code:
(require 'geiser-edit)
(require 'geiser-autodoc)
diff --git a/elisp/geiser-doc.el b/elisp/geiser-doc.el
index a982997..b098225 100644
--- a/elisp/geiser-doc.el
+++ b/elisp/geiser-doc.el
@@ -10,6 +10,7 @@
;; Start date: Sat Feb 14, 2009 14:09
+;;; Code:
(require 'geiser-edit)
(require 'geiser-impl)
diff --git a/elisp/geiser-edit.el b/elisp/geiser-edit.el
index bca57a3..8eef936 100644
--- a/elisp/geiser-edit.el
+++ b/elisp/geiser-edit.el
@@ -10,6 +10,7 @@
;; Start date: Wed Feb 11, 2009 21:07
+;;; Code:
(require 'geiser-completion)
(require 'geiser-eval)
diff --git a/elisp/geiser-eval.el b/elisp/geiser-eval.el
index 6209dd3..9e8e609 100644
--- a/elisp/geiser-eval.el
+++ b/elisp/geiser-eval.el
@@ -13,6 +13,7 @@
;; code.
+;;; Code:
(require 'geiser-impl)
(require 'geiser-connection)
diff --git a/elisp/geiser-image.el b/elisp/geiser-image.el
index 084cd69..2b496c2 100644
--- a/elisp/geiser-image.el
+++ b/elisp/geiser-image.el
@@ -11,6 +11,7 @@
;; Start date: Sun Sep 02, 2012 00:00
+;;; Code:
(require 'geiser-custom)
(require 'geiser-base)
diff --git a/elisp/geiser-impl.el b/elisp/geiser-impl.el
index 11ae14a..5ceee17 100644
--- a/elisp/geiser-impl.el
+++ b/elisp/geiser-impl.el
@@ -10,6 +10,7 @@
;; Start date: Sat Mar 07, 2009 23:32
+;;; Code:
(require 'geiser-custom)
(require 'geiser-base)
diff --git a/elisp/geiser-log.el b/elisp/geiser-log.el
index ac52fed..a0d7878 100644
--- a/elisp/geiser-log.el
+++ b/elisp/geiser-log.el
@@ -9,11 +9,14 @@
;; Start date: Sat Feb 07, 2009 12:07
-
+;;; Commentary:
;; Some utilities for maintaining a simple log buffer, mainly for
;; debugging purposes.
+
+;;; Code:
+
(require 'geiser-custom)
(require 'geiser-popup)
(require 'geiser-base)
diff --git a/elisp/geiser-menu.el b/elisp/geiser-menu.el
index 59d2ed6..11a389c 100644
--- a/elisp/geiser-menu.el
+++ b/elisp/geiser-menu.el
@@ -8,7 +8,9 @@
;; not, see <http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5>.
;; Start date: Sat Jun 12, 2010 03:01
+
+;;; Code:
(require 'geiser-custom)
(require 'geiser-base)
diff --git a/elisp/geiser-mode.el b/elisp/geiser-mode.el
index b017184..7b37169 100644
--- a/elisp/geiser-mode.el
+++ b/elisp/geiser-mode.el
@@ -10,6 +10,7 @@
;; Start date: Sun Feb 08, 2009 15:13
+;;; Code:
(require 'geiser-repl)
(require 'geiser-menu)
diff --git a/elisp/geiser-popup.el b/elisp/geiser-popup.el
index 397ede6..9db085f 100644
--- a/elisp/geiser-popup.el
+++ b/elisp/geiser-popup.el
@@ -9,6 +9,9 @@
;; Start date: Sat Feb 07, 2009 14:05
+
+;;; Code:
+
(require 'view)
diff --git a/elisp/geiser-reload.el b/elisp/geiser-reload.el
index 89c0854..287a768 100644
--- a/elisp/geiser-reload.el
+++ b/elisp/geiser-reload.el
@@ -10,6 +10,7 @@
;; Start date: Sat Aug 22, 2009 23:04
+;;; Code:
(require 'geiser-repl)
(require 'geiser-mode)
diff --git a/elisp/geiser-repl.el b/elisp/geiser-repl.el
index 54458e5..296b3ca 100644
--- a/elisp/geiser-repl.el
+++ b/elisp/geiser-repl.el
@@ -8,6 +8,7 @@
;; not, see <http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5>.
+;;; Code:
(require 'geiser-company)
(require 'geiser-doc)
diff --git a/elisp/geiser-syntax.el b/elisp/geiser-syntax.el
index 4d58888..7870d3b 100644
--- a/elisp/geiser-syntax.el
+++ b/elisp/geiser-syntax.el
@@ -10,6 +10,7 @@
;; Start date: Sun Feb 08, 2009 15:03
+;;; Code:
(require 'geiser-impl)
(require 'geiser-popup)
diff --git a/elisp/geiser-table.el b/elisp/geiser-table.el
index ab7451d..012715e 100644
--- a/elisp/geiser-table.el
+++ b/elisp/geiser-table.el
@@ -10,6 +10,7 @@
;; Start date: Tue Jan 06, 2009 13:44
+;;; Code:
(defun geiser-table--col-widths (rows)
(let* ((col-no (length (car rows)))
diff --git a/elisp/geiser-xref.el b/elisp/geiser-xref.el
index 76f64c4..432aa4a 100644
--- a/elisp/geiser-xref.el
+++ b/elisp/geiser-xref.el
@@ -10,6 +10,7 @@
;; Start date: Thu Mar 05, 2009 23:03
+;;; Code:
(require' geiser-edit)
(require 'geiser-autodoc)
diff --git a/elisp/geiser.el b/elisp/geiser.el
index 774ee54..478b10c 100644
--- a/elisp/geiser.el
+++ b/elisp/geiser.el
@@ -8,9 +8,12 @@
;; have received a copy of the license along with this program. If
;; not, see <http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5>.
-
+;;; Commentary:
+
;; Autoloads and basic setup for geiser.
+
+;;; Code:
;;; Locations:
;;;###autoload