From a9593253e90aa58134833078ae1fc5505ae9f58c Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Mon, 29 Jul 2019 14:46:37 +0200 Subject: [PATCH] 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 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 -- 2.39.2