procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add further documentation about semicolon use

Browse source 
* doc/lispref/tips.texi (Comment Tips): Document the sub-heading
convention (bug#23060) as explained by Stefan on StackExchange.
This commit is contained in:
Lars Ingebrigtsen 2019-07-29 14:46:37 +02:00
parent fa04c8b87e
commit a9593253e9
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/lispref/tips.texi
View 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