[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#42397: [PATCH 00/14] Use outline headings and some cosmetics
From: |
Drew Adams |
Subject: |
bug#42397: [PATCH 00/14] Use outline headings and some cosmetics |
Date: |
Thu, 16 Jul 2020 08:12:24 -0700 (PDT) |
I thought we had a pretty standard header format.
I've been respecting that for decades in my own
libraries. Now it's changed?
My understanding has been:
3 ; for the first header line.
3 ; for a ;;; Commentary: line.
3 ; for a ;;; Change Log: line. (Used to be Chang log.)
3 ; for a ;;; Code: line.
More than 3 ; for any "separator" line.
2 ; for all other header lines.
____
And 3 ; for the file footer. E.g.:
;;; foo-lib.el ends here
____
And within the code, whatever you want, per
convention (3 for major, 2 for minor, 1 at eol).
____
Further, I thought the convention called for
2 SPC after the initial 3 ; or 2 ;, except
for 4 SPC before the first Commentary text,
i.e., the file description. E.g.:
;;; Commentary:
;;
;; Here is a one-line library description.
;;
;; Here are any commentary details that might
;; be present - anything at all.
____
Dunno whether such a convention is still
stated somewhere, but I'm pretty sure it
was in place in the past.
bug#42397: [PATCH 01/14] ; * lisp/epg.el (epg-signature-to-string): Use cl-case., Robert Pluim, 2020/07/16
bug#42397: This message is a test, Jonas Bernoulli, 2020/07/16
bug#42397: [PATCH 00/14] Use outline headings and some cosmetics,
Drew Adams <=