emacs-diffs
[Top][All Lists]
Advanced

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

[Emacs-diffs] master a959325: Add further documentation about semicolon


From: Lars Ingebrigtsen
Subject: [Emacs-diffs] master a959325: Add further documentation about semicolon use
Date: Mon, 29 Jul 2019 08:46:44 -0400 (EDT)

branch: master
commit a9593253e90aa58134833078ae1fc5505ae9f58c
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    Add further documentation about semicolon use
    
    * doc/lispref/tips.texi (Comment Tips): Document the sub-heading
    convention (bug#23060) as explained by Stefan on StackExchange.
---
 doc/lispref/tips.texi | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 30f2c98..01e9a3a 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -916,13 +916,16 @@ is discouraged.
 When commenting out entire functions, use two semicolons.
 
 @item ;;;;
-Comments that start with four semicolons, @samp{;;;;}, should be aligned
-to the left margin and are used for headings of major sections of a
-program.  For example:
+Comments that start with four (or more) semicolons, @samp{;;;;},
+should be aligned to the left margin and are used for headings of
+major sections of a program.  For example:
 
 @smallexample
 ;;;; The kill ring
 @end smallexample
+
+If you wish to have sub-headings under these heading, use more
+semicolons to nest these sub-headings.
 @end table
 
 @noindent



reply via email to

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