diff options
author | Lars Ingebrigtsen <larsi@gnus.org> | 2019-07-29 14:46:37 +0200 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2019-07-29 14:46:37 +0200 |
commit | a9593253e90aa58134833078ae1fc5505ae9f58c (patch) | |
tree | 86a2644bd681923e57c66af68abf945671552997 /doc/lispref/tips.texi | |
parent | fa04c8b87e50a2e2b0d021958f637be8f475d8bc (diff) | |
download | emacs-a9593253e90aa58134833078ae1fc5505ae9f58c.tar.gz |
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.
Diffstat (limited to 'doc/lispref/tips.texi')
-rw-r--r-- | doc/lispref/tips.texi | 9 |
1 files 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 |