emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/geiser-gambit c0db9f3 19/34: Mark the beginning of code pa


From: Philip Kaludercic
Subject: [nongnu] elpa/geiser-gambit c0db9f3 19/34: Mark the beginning of code part of elisp libraries with Code: heading
Date: Sun, 1 Aug 2021 18:27:18 -0400 (EDT)

branch: elpa/geiser-gambit
commit c0db9f34374453842471937e9906103b0bec7b47
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>

    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.
---
 elisp/geiser-gambit.el | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/elisp/geiser-gambit.el b/elisp/geiser-gambit.el
index 4ced1ae..a34cd49 100644
--- a/elisp/geiser-gambit.el
+++ b/elisp/geiser-gambit.el
@@ -11,12 +11,17 @@
 
 ;; Start date: Sun Mar 08, 2009 23:03
 
+;;; Commentary:
+
 ;; Gambit in geiser, thank you to Chris Blom for the start he did few years ago
 ;; https://github.com/ChrisBlom
 
 ;; TODO
 ;; [ ] the gambit guessing words lists
 
+
+;;; Code:
+
 (require 'geiser-connection)
 (require 'geiser-syntax)
 (require 'geiser-custom)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]