From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Mon, 29 Jul 2019 12:46:37 +0000 (+0200)
Subject: Add further documentation about semicolon use
X-Git-Tag: emacs-27.0.90~1817^2~35
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=a9593253e90aa58134833078ae1fc5505ae9f58c;p=emacs.git

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.
---

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 30f2c983adc..01e9a3a851f 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