summaryrefslogtreecommitdiff
path: root/elisp/geiser-autodoc.el
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/geiser-autodoc.el
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/geiser-autodoc.el')
-rw-r--r--elisp/geiser-autodoc.el1
1 files changed, 1 insertions, 0 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)