]> git.eshelyaron.com Git - emacs.git/commitdiff
Add further documentation about semicolon use
authorLars Ingebrigtsen <larsi@gnus.org>
Mon, 29 Jul 2019 12:46:37 +0000 (14:46 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Mon, 29 Jul 2019 12:46:37 +0000 (14:46 +0200)
* doc/lispref/tips.texi (Comment Tips): Document the sub-heading
convention (bug#23060) as explained by Stefan on StackExchange.

doc/lispref/tips.texi

index 30f2c983adc1cafd4efa2e810243c34896b76c80..01e9a3a851fe067f9fbded5da3e92e9d3188a808 100644 (file)
@@ -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