bug#15820: 24.3.50; (elisp) `File Local Variables'

bug#15820: 24.3.50; (elisp) `File Local Variables'

[Drew Adams]

This part of the text is unclear:

  When defining a user option using `defcustom', you can set its
  `safe-local-variable' property by adding the arguments `:safe FUNCTION'
  to `defcustom'

FUNCTION needs to be described here.  Just say that FUNCTION is the same
as the function used as the value of property `safe-local-variable'.

That will provide readers the understanding that FUNCTION "has to be a
function of one argument; any value is safe if the function returns
non-`nil' given that value."

In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-10-19 on LEG570
Bzr revision: 114715 rgm@gnu.org-20131019023520-s8mwtib7xcx9e05w
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1'

bug#15820: 24.3.50; (elisp) `File Local Variables'

[Glenn Morris]

Drew Adams wrote:

> This part of the text is unclear:
>
>   When defining a user option using `defcustom', you can set its
>   `safe-local-variable' property by adding the arguments `:safe FUNCTION'
>   to `defcustom'
>
> FUNCTION needs to be described here.  Just say that FUNCTION is the same
> as the function used as the value of property `safe-local-variable'.

It is explained in the immediately previous paragraph.
Repeating it seems unnecessarily verbose, and we all hate unnecessary
verbosity, don't we?

bug#15820: 24.3.50; (elisp) `File Local Variables'

[Drew Adams]

> > This part of the text is unclear:
> >
> >   When defining a user option using `defcustom', you can set its
> >   `safe-local-variable' property by adding the arguments `:safe
> >   FUNCTION' to `defcustom'
> >
> > FUNCTION needs to be described here.  Just say that FUNCTION is
> > the same as the function used as the value of property
> > `safe-local-variable'.
> 
> It is explained in the immediately previous paragraph.

FUNCTION is not described there.  What is described there is the
function that is the value of property `safe-local-variable'.

But I was mistaken that the connection between the two is not made
clear.  They are connected in the same sentence, by saying that
:safe FUNCTION _sets_ the property.  It is reasonable to assume
that FUNCTION is used as the value that is set.  Not a bug.  Thx.

bug#15820: 24.3.50; (elisp) `File Local Variables'

[Michael Heerdegen]

Glenn Morris <rgm@gnu.org> writes:

> It is explained in the immediately previous paragraph.
> Repeating it seems unnecessarily verbose, and we all hate unnecessary
> verbosity, don't we?

Don't be so schnippisch!


Regards,

Michael.