]> git.eshelyaron.com Git - emacs.git/commitdiff
Recommend lexical-binding in Coding Conventions
authorStefan Kangas <stefan@marxist.se>
Tue, 20 Oct 2020 23:50:50 +0000 (01:50 +0200)
committerStefan Kangas <stefan@marxist.se>
Thu, 22 Oct 2020 18:28:59 +0000 (20:28 +0200)
* doc/lispref/tips.texi (Coding Conventions, Library Headers):
Recommend using lexical-binding.

doc/lispref/tips.texi

index 5b09b2ccea6159c5682886937e39634108240a40..4d6dcb9f8340b38f64ea43ee22b1bc1f46ac793a 100644 (file)
@@ -94,6 +94,11 @@ it to Emacs.  If and when we do, we can change the name easily enough.
 If one prefix is insufficient, your package can use two or three
 alternative common prefixes, so long as they make sense.
 
+@item
+We recommend enabling @code{lexical-binding} in new code, and
+converting existing Emacs Lisp code to enable @code{lexical-binding}
+if it doesn't already.  @xref{Using Lexical Binding}.
+
 @item
 Put a call to @code{provide} at the end of each separate Lisp file.
 @xref{Named Features}.
@@ -963,7 +968,7 @@ explains these conventions, starting with an example:
 
 @smallexample
 @group
-;;; foo.el --- Support for the Foo programming language
+;;; foo.el --- Support for the Foo programming language  -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 2010-2020 Your Name
 @end group
@@ -986,14 +991,14 @@ explains these conventions, starting with an example:
   The very first line should have this format:
 
 @example
-;;; @var{filename} --- @var{description}
+;;; @var{filename} --- @var{description}  -*- lexical-binding: t; -*-
 @end example
 
 @noindent
-The description should be contained in one line.  If the file
-needs a @samp{-*-} specification, put it after @var{description}.
-If this would make the first line too long, use a Local Variables
-section at the end of the file.
+The description should be contained in one line.  If the file needs to
+set more variables in the @samp{-*-} specification, add it after
+@code{lexical-binding}.  If this would make the first line too long, use
+a Local Variables section at the end of the file.
 
   The copyright notice usually lists your name (if you wrote the
 file).  If you have an employer who claims copyright on your work, you