Skip to content

Commit b0c6e9e

Browse files
committed
Merge pull request #19 from Bruce-Connor/semicolons
Reconcile comment section with the elisp reference
2 parents 1b9a0d8 + 4227218 commit b0c6e9e

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -405,25 +405,27 @@ name clashes.
405405
406406
* Endeavor to make your code as self-documenting as possible.
407407
408-
* Write heading comments with at least four semicolons.
408+
* Write heading comments with at least three semicolons.
409409
410-
* Write top-level comments with three semicolons.
410+
* Write top-level comments with three semicolons if it represents a
411+
heading, otherwise use two semicolons.
411412
412413
* Write comments on a particular fragment of code before that fragment
413-
and aligned with it, using two semicolons.
414+
and aligned with it, using two semicolons.
414415
415416
* Write margin comments with one semicolon.
416417
417418
* Always have at least one space between the semicolon
418419
and the text that follows it.
419420
420421
```el
421-
;;;; Frob Grovel
422+
;;; Frob Grovel
423+
;; This is where Frob grovels and where Grovel frobs.
422424
423-
;;; This section of code has some important implications:
424-
;;; 1. Foo.
425-
;;; 2. Bar.
426-
;;; 3. Baz.
425+
;; This section of code has some important implications:
426+
;; 1. Foo.
427+
;; 2. Bar.
428+
;; 3. Baz.
427429
428430
(defun fnord (zarquon)
429431
;; If zob, then veeblefitz.

0 commit comments

Comments
 (0)